Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Yann E. MORIN <yann.morin.1998@free.fr>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 2/4 v2] tools: move test-pkg out of support/scripts
Date: Thu, 22 Jun 2017 21:20:53 +0200	[thread overview]
Message-ID: <20170622192053.GB3054@scaer> (raw)
In-Reply-To: <87cff805-8af2-fa92-33b6-2f8f20418f7e@mind.be>

Arnout, Thomas, All,

On 2017-06-22 10:30 +0200, Arnout Vandecappelle spake thusly:
> 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

OK, I'll re-instate the readme, and will change its name to readme.txt.

>  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 :-)

IIUC, github et al. expect README.md to contain Markdown, not plain
text. A simple README (or maybe readme as well) would still be
displayed, but no rednering would be done.

In any case, this is a topic for a completely different series.

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

  reply	other threads:[~2017-06-22 19:20 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-18 14:01 [Buildroot] [PATCH 0/4 v2] tools: add a directory to contain usefull user-facing tools Yann E. MORIN
2017-06-18 14:01 ` [Buildroot] [PATCH 1/4 v2] tools: add a directory to store some useful " Yann E. MORIN
2017-06-19  1:11   ` Ricardo Martincoski
2017-06-19 15:42     ` Yann E. MORIN
2017-06-21  2:06       ` Ricardo Martincoski
2017-06-21  5:21         ` Yann E. MORIN
2017-06-21 21:44           ` Arnout Vandecappelle
2017-06-22 19:18             ` Yann E. MORIN
2017-06-18 14:01 ` [Buildroot] [PATCH 2/4 v2] tools: move test-pkg out of support/scripts Yann E. MORIN
2017-06-18 14:12   ` Thomas Petazzoni
2017-06-18 14:16     ` Yann E. MORIN
2017-06-22  7:57     ` Arnout Vandecappelle
2017-06-22  8:13       ` Thomas Petazzoni
2017-06-22  8:30         ` Arnout Vandecappelle
2017-06-22 19:20           ` Yann E. MORIN [this message]
2017-06-18 14:01 ` [Buildroot] [PATCH 3/4 v2] tools: move get-developers out of support/scripts/ Yann E. MORIN
2017-06-18 14:01 ` [Buildroot] [PATCH 4/4 v2] tools: move check-package " Yann E. MORIN
2017-06-19  1:13   ` Ricardo Martincoski
2017-06-19 18:46     ` Yann E. MORIN
2017-06-19  3:22   ` Ricardo Martincoski
2017-06-19 18:48     ` Yann E. MORIN
2017-06-19 20:27       ` Ricardo Martincoski
2017-06-18 14:15 ` [Buildroot] [PATCH 0/4 v2] tools: add a directory to contain usefull user-facing tools Thomas Petazzoni
2017-06-18 14:23   ` Yann E. MORIN
2017-06-21 22:04     ` Arnout Vandecappelle

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170622192053.GB3054@scaer \
    --to=yann.morin.1998@free.fr \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox