[Buildroot] [PATCH] manual: Add a note for dependency comment format

[Maxime Hadjinlian]

On Sun, Feb 23, 2014 at 3:44 PM, Thomas Petazzoni
<thomas.petazzoni at free-electrons.com> wrote:
> Dear Maxime Hadjinlian,
>
> On Sun, 23 Feb 2014 15:35:37 +0100, Maxime Hadjinlian wrote:
>> Hi Thomas, all
>> On Sun, Feb 23, 2014 at 3:04 PM, Thomas Petazzoni
>> <thomas.petazzoni at free-electrons.com> wrote:
>> > Dear Maxime Hadjinlian,
>> >
>> > On Sun, 23 Feb 2014 14:05:48 +0100, Maxime Hadjinlian wrote:
>> >> Add a quick note to clarify that the format of the depencency comments
>> >> applies irregardless of the number of dependencies.
>> >>
>> >> Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian at gmail.com>
>> >> ---
>> >>  docs/manual/adding-packages-directory.txt | 1 +
>> >>  1 file changed, 1 insertion(+)
>> >>
>> >> diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
>> >> index 3dc5395..b6dc981 100644
>> >> --- a/docs/manual/adding-packages-directory.txt
>> >> +++ b/docs/manual/adding-packages-directory.txt
>> >> @@ -205,6 +205,7 @@ aircrack-ng needs a toolchain w/ largefile, threads
>> >>
>> >>  Note that this text is kept brief on purpose, so that it will fit on a
>> >>  80-character terminal.
>> >> +This format must be repected even if there is only one dependency.
>> >
>> > I'm not sure what you mean here. Could you explain a bit more?
>> The examples always give with n depedency. Someone may ask himself if
>> this format is valid for only one depedency.
>> Should it reduce the with to w/, etc...
>
> Then it is unclear, because your sentence come right after the sentence
> mentioning the 80-character limit. So when I read this, I thought you
> were saying "even when there is a single dependency, the text must fit
> on a 80-character terminal", which doesn't made much sense.
Ok, maybe transform this block in a:
Note:
 - bla
 - bla
Would be better, or moving it somewhere else ? Or simply putting up
another example with only one dependency ?
>
> Thomas
> --
> Thomas Petazzoni, CTO, Free Electrons
> Embedded Linux, Kernel and Android engineering
> http://free-electrons.com