Skip to contentSkip to conversation

manual: Add a note for dependency comment format

PATCH New Maxime Hadjinlian 2 participants 5 messages Feb 23, 2014

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 manual: Add a note for dependency comment format

Add a quick note to clarify that the format of the depencency comments applies irregardless of the number of dependencies.

---
 docs/manual/adding-packages-directory.txt | 1 +
 1 file changed, 1 insertion(+)
docs/manual/adding-packages-directory.txt +1 -0
index 3dc5395..b6dc981 100644
@@ -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.
 
 The rest of this section enumerates the different target and toolchain
 options, the corresponding config symbols to depend on, and the text to
Signature · 1 line
1.8.5.3
#1 lore raw

PATCH 1/1 manual: Add a note for dependency comment format

Dear Maxime Hadjinlian,

Quoted 13 lines · Maxime Hadjinlian

Add a quick note to clarify that the format of the depencency comments applies irregardless of the number of dependencies.

---
 docs/manual/adding-packages-directory.txt | 1 +
 1 file changed, 1 insertion(+)
docs/manual/adding-packages-directory.txt +0 -0
index 3dc5395..b6dc981 100644

docs/manual/adding-packages-directory.txt aircrack-ng needs a toolchain w/ largefile, threads · line 208

Quoted 4 lines
docs/manual/adding-packages-directory.txt +1 -0
@@ -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?

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com
#2 lore raw

PATCH 1/1 manual: Add a note for dependency comment format

Hi Thomas, all

Quoted 17 lines · Thomas Petazzoni

Dear Maxime Hadjinlian,

Quoted 14 lines · Maxime Hadjinlian

Add a quick note to clarify that the format of the depencency comments applies irregardless of the number of dependencies.

---
 docs/manual/adding-packages-directory.txt | 1 +
 1 file changed, 1 insertion(+)
docs/manual/adding-packages-directory.txt +0 -0
index 3dc5395..b6dc981 100644
@@ -205,6 +205,7 @@ aircrack-ng needs a toolchain w/ largefile, threads
 
Quoted 5 lines

docs/manual/adding-packages-directory.txt aircrack-ng needs a toolchain w/ largefile, threads · line 208

Quoted 3 lines
docs/manual/adding-packages-directory.txt +1 -0
 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...

Quoted 6 lines

Thomas
--
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

#3 lore raw

PATCH 1/1 manual: Add a note for dependency comment format

Dear Maxime Hadjinlian,

Quoted 20 lines · Maxime Hadjinlian

Hi Thomas, all

Quoted 17 lines · Thomas Petazzoni

Dear Maxime Hadjinlian,

Quoted 14 lines · Maxime Hadjinlian

Add a quick note to clarify that the format of the depencency comments applies irregardless of the number of dependencies.

---
 docs/manual/adding-packages-directory.txt | 1 +
 1 file changed, 1 insertion(+)
docs/manual/adding-packages-directory.txt +0 -0
index 3dc5395..b6dc981 100644
@@ -205,6 +205,7 @@ aircrack-ng needs a toolchain w/ largefile, threads
 
Quoted 8 lines
Quoted 5 lines

docs/manual/adding-packages-directory.txt aircrack-ng needs a toolchain w/ largefile, threads · line 208

Quoted 3 lines
docs/manual/adding-packages-directory.txt +1 -0
 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.

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com
#4 lore raw

PATCH 1/1 manual: Add a note for dependency comment format

Quoted 28 lines · Thomas Petazzoni

Dear Maxime Hadjinlian,

Quoted 25 lines · Maxime Hadjinlian

Hi Thomas, all

Quoted 22 lines · Thomas Petazzoni

Dear Maxime Hadjinlian,

Quoted 13 lines · Maxime Hadjinlian

Add a quick note to clarify that the format of the depencency comments applies irregardless of the number of dependencies.

---
 docs/manual/adding-packages-directory.txt | 1 +
 1 file changed, 1 insertion(+)
docs/manual/adding-packages-directory.txt +0 -0
index 3dc5395..b6dc981 100644

docs/manual/adding-packages-directory.txt aircrack-ng needs a toolchain w/ largefile, threads · line 208

Quoted 4 lines
docs/manual/adding-packages-directory.txt +1 -0
@@ -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?

Quoted 8 lines
Quoted 3 lines

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 ?

Quoted 6 lines

Thomas
--
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com