Documentation cleanup
cover Documentation cleanup
Hi,
Here is a series that fixes a few typoes and makes small improvements
in documentation.
Regards,
Jerzy
Jerzy Grzegorek (6):
manual/common-usage.txt: fix typo manual/customize-packages.txt: reword part about applying patches manual/faq-troubleshooting.txt: remove the extra 'the' manual/adding-packages-generic.txt: fix capitalization in titles of
chapters
manual/adding-packages-generic.txt: change the default value of
<PKG>_SOURCE variable
manual/adding-packages-tips.txt: reword part about package name
docs/manual/adding-packages-generic.txt | 6 +++--- docs/manual/adding-packages-tips.txt | 2 +- docs/manual/common-usage.txt | 2 +- docs/manual/customize-packages.txt | 6 +++--- docs/manual/faq-troubleshooting.txt | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-)
Signature · 1 line
1.7.9.5
PATCH 1/6 manual/common-usage.txt: fix typo
Signed-off-by Jerzy Grzegorek <[email protected]>
--- docs/manual/common-usage.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
docs/manual/common-usage.txt +1 -1
@@ -140,7 +140,7 @@ Other tools may have similar options. Please consult their respective man pages. You can use sparse files if you need to store the filesystem images (eg. -to transfer from one machine to another), of if you need to send them (eg. +to transfer from one machine to another), or if you need to send them (eg. to the Q&A team). Note however that flashing a filesystem image to a device while using the
Signature · 1 line
1.7.9.5
PATCH 1/6 manual/common-usage.txt: fix typo
Jerzy, All,
On 2014-03-20 23:07 +0100, Jerzy Grzegorek spake thusly:
Quoted 1 line
Signed-off-by Jerzy Grzegorek <[email protected]>
Acked-by "Yann E. MORIN" <[email protected]>
Regards,
Yann E. MORIN.
Quoted 24 lines
--- docs/manual/common-usage.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)docs/manual/common-usage.txt +1
-1@@ -140,7 +140,7 @@ Other tools may have similar options. Please consult their respective man pages. You can use sparse files if you need to store the filesystem images (eg. -to transfer from one machine to another), of if you need to send them (eg. +to transfer from one machine to another), or if you need to send them (eg. to the Q&A team). Note however that flashing a filesystem image to a device while using theSignature · 6 lines
1.7.9.5 _______________________________________________ buildroot mailing list buildroot at busybox.net http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | 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. | '------------------------------^-------^------------------^--------------------'
PATCH 2/6 manual/customize-packages.txt: reword part about applying patches
In reply to Jerzy GrzegorekSigned-off-by Jerzy Grzegorek <[email protected]>
--- docs/manual/customize-packages.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
docs/manual/customize-packages.txt +3 -3
@@ -59,9 +59,9 @@ directory. The exception to +BR2_GLOBAL_PATCH_DIR+ being the preferred method for specifying custom patches is +BR2_LINUX_KERNEL_PATCH+. +BR2_LINUX_KERNEL_PATCH+ should be used to specify kernel patches that -are available at an URL. *Note:* +BR2_LINUX_KERNEL_PATCHES+ are applied -after patches available in +BR2_GLOBAL_PATCH_DIR+, as it is done -from a post-patch hook of the Linux package. +are available at an URL. *Note:* +BR2_LINUX_KERNEL_PATCH+ specifies kernel +patches that are applied after patches available in +BR2_GLOBAL_PATCH_DIR+, +as it is done from a post-patch hook of the Linux package. An example directory structure for where a user has multiple directories specified for +BR2_GLOBAL_PATCH_DIR+ may look like this:
Signature · 1 line
1.7.9.5
PATCH 2/6 manual/customize-packages.txt: reword part about applying patches
Jerzy, All,
On 2014-03-20 23:07 +0100, Jerzy Grzegorek spake thusly:
Quoted 1 line
Signed-off-by Jerzy Grzegorek <[email protected]>
Reviewed-by "Yann E. MORIN" <[email protected]>
Regards,
Yann E. MORIN.
Quoted 28 lines
--- docs/manual/customize-packages.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)docs/manual/customize-packages.txt +3
-3@@ -59,9 +59,9 @@ directory. The exception to +BR2_GLOBAL_PATCH_DIR+ being the preferred method for specifying custom patches is +BR2_LINUX_KERNEL_PATCH+. +BR2_LINUX_KERNEL_PATCH+ should be used to specify kernel patches that -are available at an URL. *Note:* +BR2_LINUX_KERNEL_PATCHES+ are applied -after patches available in +BR2_GLOBAL_PATCH_DIR+, as it is done -from a post-patch hook of the Linux package. +are available at an URL. *Note:* +BR2_LINUX_KERNEL_PATCH+ specifies kernel +patches that are applied after patches available in +BR2_GLOBAL_PATCH_DIR+, +as it is done from a post-patch hook of the Linux package. An example directory structure for where a user has multiple directories specified for +BR2_GLOBAL_PATCH_DIR+ may look like this:Signature · 6 lines
1.7.9.5 _______________________________________________ buildroot mailing list buildroot at busybox.net http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | 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. | '------------------------------^-------^------------------^--------------------'
PATCH 3/6 manual/faq-troubleshooting.txt: remove the extra 'the'
In reply to Jerzy GrzegorekSigned-off-by Jerzy Grzegorek <[email protected]>
--- docs/manual/faq-troubleshooting.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
docs/manual/faq-troubleshooting.txt +1 -1
@@ -117,7 +117,7 @@ Why doesn't Buildroot generate binary packages (.deb, .ipkg...)? ---------------------------------------------------------------- One feature that is often discussed on the Buildroot list is the -the general topic of "package management". To summarize, the idea +general topic of "package management". To summarize, the idea would be to add some tracking of which Buildroot package installs what files, with the goals of:
Signature · 1 line
1.7.9.5
PATCH 3/6 manual/faq-troubleshooting.txt: remove the extra 'the'
Jerzy, All,
On 2014-03-20 23:07 +0100, Jerzy Grzegorek spake thusly:
Quoted 1 line
Signed-off-by Jerzy Grzegorek <[email protected]>
Acked-by "Yann E. MORIN" <[email protected]>
Regards,
Yann E. MORIN.
Quoted 24 lines
--- docs/manual/faq-troubleshooting.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)docs/manual/faq-troubleshooting.txt +1
-1@@ -117,7 +117,7 @@ Why doesn't Buildroot generate binary packages (.deb, .ipkg...)? ---------------------------------------------------------------- One feature that is often discussed on the Buildroot list is the -the general topic of "package management". To summarize, the idea +general topic of "package management". To summarize, the idea would be to add some tracking of which Buildroot package installs what files, with the goals of:Signature · 6 lines
1.7.9.5 _______________________________________________ buildroot mailing list buildroot at busybox.net http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | 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. | '------------------------------^-------^------------------^--------------------'
PATCH 4/6 manual/adding-packages-generic.txt: fix capitalization in titles of chapters
In reply to Jerzy GrzegorekSigned-off-by Jerzy Grzegorek <[email protected]>
--- docs/manual/adding-packages-generic.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
docs/manual/adding-packages-generic.txt +2 -2
@@ -11,7 +11,7 @@ system is based on hand-written Makefiles or shell scripts. [[generic-package-tutorial]] -+generic-package+ Tutorial ++generic-package+ tutorial ^^^^^^^^^^^^^^^^^^^^^^^^^^ ------------------------------
@@ -159,7 +159,7 @@ Makefile code necessary to make your package working. [[generic-package-reference]] -+generic-package+ Reference ++generic-package+ reference ^^^^^^^^^^^^^^^^^^^^^^^^^^^ There are two variants of the generic target. The +generic-package+ macro is
Signature · 1 line
1.7.9.5
PATCH 4/6 manual/adding-packages-generic.txt: fix capitalization in titles of chapters
Jerzy, All,
On 2014-03-20 23:07 +0100, Jerzy Grzegorek spake thusly:
Quoted 1 line
Signed-off-by Jerzy Grzegorek <[email protected]>
Acked-by "Yann E. MORIN" <[email protected]>
Regards,
Yann E. MORIN.
Quoted 33 lines
--- docs/manual/adding-packages-generic.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)docs/manual/adding-packages-generic.txt +2
-2@@ -11,7 +11,7 @@ system is based on hand-written Makefiles or shell scripts. [[generic-package-tutorial]] -+generic-package+ Tutorial ++generic-package+ tutorial ^^^^^^^^^^^^^^^^^^^^^^^^^^ ------------------------------@@ -159,7 +159,7 @@ Makefile code necessary to make your package working. [[generic-package-reference]] -+generic-package+ Reference ++generic-package+ reference ^^^^^^^^^^^^^^^^^^^^^^^^^^^ There are two variants of the generic target. The +generic-package+ macro isSignature · 6 lines
1.7.9.5 _______________________________________________ buildroot mailing list buildroot at busybox.net http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | 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. | '------------------------------^-------^------------------^--------------------'
PATCH 5/6 manual/adding-packages-generic.txt: change the default value of <PKG>_SOURCE variable
In reply to Jerzy GrzegorekSigned-off-by Jerzy Grzegorek <[email protected]>
--- docs/manual/adding-packages-generic.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
docs/manual/adding-packages-generic.txt +1 -1
@@ -211,7 +211,7 @@ information is (assuming the package name is +libfoo+) : the package. If +HOST_LIBFOO_SOURCE+ is not specified, it defaults to +LIBFOO_SOURCE+. If none are specified, then the value is assumed to be - +packagename-$(LIBFOO_VERSION).tar.gz+. + + +libfoo-$(LIBFOO_VERSION).tar.gz+. + Example: +LIBFOO_SOURCE = foobar-$(LIBFOO_VERSION).tar.bz2+ * +LIBFOO_PATCH+ may contain a space-separated list of patch file
Signature · 1 line
1.7.9.5
PATCH 5/6 manual/adding-packages-generic.txt: change the default value of <PKG>_SOURCE variable
Jerzy, All,
On 2014-03-20 23:07 +0100, Jerzy Grzegorek spake thusly:
Quoted 1 line
Signed-off-by Jerzy Grzegorek <[email protected]>
Acked-by "Yann E. MORIN" <[email protected]>
Regards,
Yann E. MORIN.
Quoted 24 lines
--- docs/manual/adding-packages-generic.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)docs/manual/adding-packages-generic.txt +1
-1@@ -211,7 +211,7 @@ information is (assuming the package name is +libfoo+) : the package. If +HOST_LIBFOO_SOURCE+ is not specified, it defaults to +LIBFOO_SOURCE+. If none are specified, then the value is assumed to be - +packagename-$(LIBFOO_VERSION).tar.gz+. + + +libfoo-$(LIBFOO_VERSION).tar.gz+. + Example: +LIBFOO_SOURCE = foobar-$(LIBFOO_VERSION).tar.bz2+ * +LIBFOO_PATCH+ may contain a space-separated list of patch fileSignature · 6 lines
1.7.9.5 _______________________________________________ buildroot mailing list buildroot at busybox.net http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | 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. | '------------------------------^-------^------------------^--------------------'
PATCH 6/6 manual/adding-packages-tips.txt: reword part about package name
In reply to Jerzy GrzegorekSigned-off-by Jerzy Grzegorek <[email protected]>
--- docs/manual/adding-packages-tips.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
docs/manual/adding-packages-tips.txt +1 -1
@@ -31,7 +31,7 @@ using the following rules: +BR2_PACKAGE_FOO_BAR_BOO+); * the +*.mk+ file variable prefix is the upper case _package name_ - `.` and `-` characters substituted with `_` (e.g.: + with `.` and `-` characters substituted with `_` (e.g.: +FOO_BAR_BOO_VERSION+).
Signature · 1 line
1.7.9.5
PATCH 6/6 manual/adding-packages-tips.txt: reword part about package name
Jerzy, All,
On 2014-03-20 23:07 +0100, Jerzy Grzegorek spake thusly:
Quoted 1 line
Signed-off-by Jerzy Grzegorek <[email protected]>
Acked-by "Yann E. MORIN" <[email protected]>
Regards,
Yann E. MORIN.
Quoted 24 lines
--- docs/manual/adding-packages-tips.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)docs/manual/adding-packages-tips.txt +1
-1@@ -31,7 +31,7 @@ using the following rules: +BR2_PACKAGE_FOO_BAR_BOO+); * the +*.mk+ file variable prefix is the upper case _package name_ - `.` and `-` characters substituted with `_` (e.g.: + with `.` and `-` characters substituted with `_` (e.g.: +FOO_BAR_BOO_VERSION+).Signature · 6 lines
1.7.9.5 _______________________________________________ buildroot mailing list buildroot at busybox.net http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | 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. | '------------------------------^-------^------------------^--------------------'
cover Documentation cleanup
In reply to Jerzy GrzegorekQuoted 9 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
"Jerzy" == Jerzy Grzegorek <[email protected]> writes:
Hi,
Here is a series that fixes a few typoes and makes small improvements
in documentation.Regards,
Jerzy
Quoted 9 lines
Jerzy Grzegorek (6):
manual/common-usage.txt: fix typomanual/customize-packages.txt: reword part about applying patchesmanual/faq-troubleshooting.txt: remove the extra 'the'manual/adding-packages-generic.txt: fix capitalization in titles of
chapters
manual/adding-packages-generic.txt: change the default value of
<PKG>_SOURCE variable
manual/adding-packages-tips.txt: reword part about package name
Committed series, thanks.
Signature · 1 line
Bye, Peter Korsgaard