[U-Boot] [RFC] Removal of doc/README.scrapyard
Hello,
I've recently been removing support for some boards and this README.scrapyard file came up again. The file is supposed to be used to keep track of removed boards.
The person removing a board is first supposed to fill in the blank fields in this README.scrapyard , which are the upstream commit ID in which the board was removed and the date at which the board was removed. Those two fields are known only after the board removal patch was applied, thus those fields need to be filled in later. This effectively means that the last removed board can have those fields undefined for an extended period of time, until someone removes another board and updates the README.scrapyard.
Only after updating README.scrapyard, one is supposed to add the board that was removed into README.scrapyard, again with blank fields for the commit ID and date of removal.
I wonder if we shouldn't get rid of this README.scrapyard. Personally, I don't find much value in it ; if I am looking for some ancient board, I just do git log -p and search for whatever I need.
What are your opinions on removing this file altogether ?
Best regards, Marek Vasut
Dear Marek,
In message 201410241709.09895.marex@denx.de you wrote:
I've recently been removing support for some boards and this README.scrapyard file came up again. The file is supposed to be used to keep track of removed boards.
Or, to put it differently, to document what was once suported and now is no longer.
I wonder if we shouldn't get rid of this README.scrapyard. Personally, I don't find much value in it ; if I am looking for some ancient board, I just do git log -p and search for whatever I need.
Well, of course you can search - but the you need to know what to dearch for. If you have no idea what to look for, then a text file listing all the options that onces existed might be helpful to focus your search - say, on specific board names and such.
That was the idea behind README.scrapyard - give you information what you could use as search anchors for closer investigations.
Best regards,
Wolfgang Denk
Hi,
On 24 October 2014 13:31, Wolfgang Denk wd@denx.de wrote:
Dear Marek,
In message 201410241709.09895.marex@denx.de you wrote:
I've recently been removing support for some boards and this README.scrapyard file came up again. The file is supposed to be used to keep track of removed boards.
Or, to put it differently, to document what was once suported and now is no longer.
I wonder if we shouldn't get rid of this README.scrapyard. Personally, I don't find much value in it ; if I am looking for some ancient board, I just do git log -p and search for whatever I need.
Well, of course you can search - but the you need to know what to dearch for. If you have no idea what to look for, then a text file listing all the options that onces existed might be helpful to focus your search - say, on specific board names and such.
That was the idea behind README.scrapyard - give you information what you could use as search anchors for closer investigations.
My 2p, I quite like the graveyard. I wonder if a maintainer could deal with updating the git hashes every now and then? I suppose if we kept a strict format then a script could be used to produce the patch.
Regards, Simon
participants (3)
-
Marek Vasut -
Simon Glass -
Wolfgang Denk