[Buildroot] [PATCH 2/4 v2] tools: move test-pkg out of support/scripts

Arnout Vandecappelle arnout at mind.be
Thu Jun 22 08:30:13 UTC 2017



On 22-06-17 10:13, Thomas Petazzoni wrote:
> Hello,
> 
> On Thu, 22 Jun 2017 09:57:36 +0200, Arnout Vandecappelle wrote:
> 
>>> No strong opinion on whether such a move is desirable, but at the very
>>> list I believe we should not add this 00-README.txt file. Nowhere else
>>> in the tree we have files named like this, and I don't think we should
>>> start adding these.  
>>
>>  Well, we have readme.txt in boards/, we have a README at the top level, we have
>> a README generated by legal-info, we have a readme.txt in checkpackagelib... We
>> indeed don't have a 00-README.txt though. IMO all of these files should be
>> called README.md (or readme.md) so they are nicely formatted when viewed online.
>>
>>  For this particular instance, I do like having some kind of README there. We
>> need an overview of the existing tools somewhere, and I think a README file is a
>> more appropriate place than the manual because it's easier to keep consistent.
>> From the manual you can point to the directory.
> 
> ACK, but then, named "readme.txt", to match what we're doing elsewhere:
> 
> $ find . -name 'readme.txt' | wc -l
> 99

 Well, the point I tried to make in the paragraph above is that readme.txt is
not a great name, readme.md would be better so it gets nicely formatted when
viewed online on github, gitlab, etc and also in some editors. README.md is even
better because then it is sorted first - which for the tools directory is very
relevant IMO.

 Note that 96 of those 99 readmes are in board/. But they still should be called
readme.md :-)

 Regards,
 Arnout

-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF



More information about the buildroot mailing list