All of lore.kernel.org
 help / color / mirror / Atom feed
* [Buildroot] [PATCH 0/9] Documentation cleanup
@ 2014-03-28 21:24 Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 1/9] manual/configure.txt: reword part about internal toolchain backend Jerzy Grzegorek
                   ` (9 more replies)
  0 siblings, 10 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Hi,

Here is a series that fixes a few typoes and makes small improvements
in documentation.

Regards,
Jerzy


Jerzy Grzegorek (9):
  manual/configure.txt: reword part about internal toolchain backend
  manual/configure.txt: fix typo
  manual/make-tips.txt: fix typo
  manual/contribute.txt: fix typo
  manual/contribute.txt: reword part about reporting issues
  manual/legal-notice.txt: fix typo
  manual/contribute.txt: reword part about versioning patches
  manual: fix typo in abbreviation 'e.g.'
  manual: fix typo in abbreviation 'i.e.'

 docs/manual/adding-packages-autotools.txt |    2 +-
 docs/manual/adding-packages-generic.txt   |    4 ++--
 docs/manual/common-usage.txt              |    8 ++++----
 docs/manual/configure.txt                 |   16 ++++++++--------
 docs/manual/contribute.txt                |    8 +++++---
 docs/manual/customize-outside-br.txt      |    2 +-
 docs/manual/faq-troubleshooting.txt       |    2 +-
 docs/manual/legal-notice.txt              |    2 +-
 docs/manual/make-tips.txt                 |    2 +-
 9 files changed, 24 insertions(+), 22 deletions(-)

-- 
1.7.9.5

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 1/9] manual/configure.txt: reword part about internal toolchain backend
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 2/9] manual/configure.txt: fix typo Jerzy Grzegorek
                   ` (8 subsequent siblings)
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/configure.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/configure.txt b/docs/manual/configure.txt
index badb6e4..16c86cc 100644
--- a/docs/manual/configure.txt
+++ b/docs/manual/configure.txt
@@ -100,7 +100,7 @@ most important ones allow to:
    toolchain should have largefile support (i.e support for files
    larger than 2 GB on 32 bits systems), IPv6 support, RPC support
    (used mainly for NFS), wide-char support, locale support (for
-   internationalization), C++ support, thread support. Depending on
+   internationalization), C++ support or thread support. Depending on
    which options you choose, the number of userspace applications and
    libraries visible in Buildroot menus will change: many applications
    and libraries require certain toolchain options to be enabled. Most
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 2/9] manual/configure.txt: fix typo
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 1/9] manual/configure.txt: reword part about internal toolchain backend Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:32   ` Thomas Petazzoni
  2014-03-28 21:24 ` [Buildroot] [PATCH 3/9] manual/make-tips.txt: " Jerzy Grzegorek
                   ` (7 subsequent siblings)
  9 siblings, 1 reply; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/configure.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/configure.txt b/docs/manual/configure.txt
index 16c86cc..869066a 100644
--- a/docs/manual/configure.txt
+++ b/docs/manual/configure.txt
@@ -165,7 +165,7 @@ Then, you have three solutions to use an external toolchain:
   prefix+ and +External toolchain C library+ options. Then, you have
   to tell Buildroot what your external toolchain supports. If your
   external toolchain uses the 'glibc' library, you only have to tell
-  whether your toolchain supports C\+\+ or not and whether it has
+  whether your toolchain supports C++ or not and whether it has
   built-in RPC support. If your external toolchain uses the 'uClibc'
   library, then you have to tell Buildroot if it supports largefile,
   IPv6, RPC, wide-char, locale, program invocation, threads and
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 3/9] manual/make-tips.txt: fix typo
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 1/9] manual/configure.txt: reword part about internal toolchain backend Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 2/9] manual/configure.txt: fix typo Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 4/9] manual/contribute.txt: " Jerzy Grzegorek
                   ` (6 subsequent siblings)
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/make-tips.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
index faf59f2..81edae3 100644
--- a/docs/manual/make-tips.txt
+++ b/docs/manual/make-tips.txt
@@ -32,7 +32,7 @@ The result of the search shows the help message of the matching items.
 Not all targets are always available,
 some settings in the +.config+ file may hide some targets:
 
-* +busybox-menuconfig+ and +busybox-savedefconfig+ ony work when
+* +busybox-menuconfig+ and +busybox-savedefconfig+ only work when
   +busybox+ is enabled;
 * +linux-menuconfig+ and +linux-savedefconfig+ only work when
   +linux+ is enabled;
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 4/9] manual/contribute.txt: fix typo
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
                   ` (2 preceding siblings ...)
  2014-03-28 21:24 ` [Buildroot] [PATCH 3/9] manual/make-tips.txt: " Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 5/9] manual/contribute.txt: reword part about reporting issues Jerzy Grzegorek
                   ` (5 subsequent siblings)
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/contribute.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
index 52d4d04..028dd90 100644
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -97,7 +97,7 @@ To indicate approval of a patch, there are three formal tags that keep
 track of this approval. To add your tag to a patch, reply to it with the
 approval tag below the original author's Signed-off-by line. These tags
 will be picked up automatically by patchwork (see
-ref:apply-patches-patchwork[]) and will be part of the commit log when
+xref:apply-patches-patchwork[]) and will be part of the commit log when
 the patch is accepted.
 
 Tested-by:: Indicates that the patch has been tested successfully.
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 5/9] manual/contribute.txt: reword part about reporting issues
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
                   ` (3 preceding siblings ...)
  2014-03-28 21:24 ` [Buildroot] [PATCH 4/9] manual/contribute.txt: " Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 6/9] manual/legal-notice.txt: fix typo Jerzy Grzegorek
                   ` (4 subsequent siblings)
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/contribute.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
index 028dd90..47494cb 100644
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -307,7 +307,7 @@ Here is a short list of details to provide in such case:
 * any information you think that may be relevant
 
 Additionally, you should add the +.config+ file (or if you know how, a
-+defconfig+).
++defconfig+; see xref:customize-store-buildroot-config[]).
 
 If some of these details are too large, do not hesitate to use a
 pastebin service. Note that not all available pastebin services will
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 6/9] manual/legal-notice.txt: fix typo
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
                   ` (4 preceding siblings ...)
  2014-03-28 21:24 ` [Buildroot] [PATCH 5/9] manual/contribute.txt: reword part about reporting issues Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 7/9] manual/contribute.txt: reword part about versioning patches Jerzy Grzegorek
                   ` (3 subsequent siblings)
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/legal-notice.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/legal-notice.txt b/docs/manual/legal-notice.txt
index f79a578..c21012d 100644
--- a/docs/manual/legal-notice.txt
+++ b/docs/manual/legal-notice.txt
@@ -99,7 +99,7 @@ Buildroot, with the name used in the manifest files:
   GNU Library General Public License, version 2];
 * `LGPLv2+`:
   http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html[
-  GNU Library General Public License, version 2.1]
+  GNU Library General Public License, version 2]
   or (at your option) any later version;
 * `LGPLv2.1`:
   http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html[
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 7/9] manual/contribute.txt: reword part about versioning patches
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
                   ` (5 preceding siblings ...)
  2014-03-28 21:24 ` [Buildroot] [PATCH 6/9] manual/legal-notice.txt: fix typo Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 8/9] manual: fix typo in abbreviation 'e.g.' Jerzy Grzegorek
                   ` (2 subsequent siblings)
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/contribute.txt |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
index 47494cb..b641ff2 100644
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -270,7 +270,9 @@ Changes v1 -> v2:
 
 Any patch revision should include the version number. The version number
 is simply composed of the letter +v+ followed by an +integer+ greater or
-equal to two (i.e. "PATCH v2", "PATCH v3" ...).
+equal to two (i.e. "PATCH v2", "PATCH v3" ...). Note that when your patch
+series is introduced by a cover letter, an overall patch version may be
+added to the cover letter in addition/instead to the individual commits.
 
 This can be easily handled with +git format-patch+ by using the option
 +--subject-prefix+:
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 8/9] manual: fix typo in abbreviation 'e.g.'
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
                   ` (6 preceding siblings ...)
  2014-03-28 21:24 ` [Buildroot] [PATCH 7/9] manual/contribute.txt: reword part about versioning patches Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-28 21:24 ` [Buildroot] [PATCH 9/9] manual: fix typo in abbreviation 'i.e.' Jerzy Grzegorek
  2014-03-29  8:33 ` [Buildroot] [PATCH 0/9] Documentation cleanup Thomas Petazzoni
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/adding-packages-generic.txt |    4 ++--
 docs/manual/common-usage.txt            |    8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index e125498..faee3e9 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -150,7 +150,7 @@ On line 31..33, we define a device-node file used by this package
 On line 35..37, we define the permissions to set to specific files
 installed by this package (+LIBFOO_PERMISSIONS+).
 
-On lines 39..41, we define a user that is used by this package (eg.
+On lines 39..41, we define a user that is used by this package (e.g.
 to run a daemon as non-root) (+LIBFOO_USERS+).
 
 Finally, on line 43, we call the +generic-package+ function, which
@@ -335,7 +335,7 @@ information is (assuming the package name is +libfoo+) :
   This variable is optional.
 
 * +LIBFOO_USERS+ lists the users to create for this package, if it installs
-  a program you want to run as a specific user (eg. as a daemon, or as a
+  a program you want to run as a specific user (e.g. as a daemon, or as a
   cron-job). The syntax is similar in spirit to the makedevs one, and is
   described in the xref:makeuser-syntax[]. This variable is optional.
 
diff --git a/docs/manual/common-usage.txt b/docs/manual/common-usage.txt
index ca1bffe..d9de598 100644
--- a/docs/manual/common-usage.txt
+++ b/docs/manual/common-usage.txt
@@ -116,7 +116,7 @@ Dealing efficiently with filesystem images
 
 Filesystem images can get pretty big, depending on the filesystem you choose,
 the number of packages, whether you provisioned free space... Yet, some
-locations in the filesystems images may just be _empty_ (eg. a long run of
+locations in the filesystems images may just be _empty_ (e.g. a long run of
 'zeroes'); such a file is called a _sparse_ file.
 
 Most tools can handle sparse files efficiently, and will only store or write
@@ -139,12 +139,12 @@ For example:
 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), or if you need to send them (eg.
+You can use sparse files if you need to store the filesystem images (e.g.
+to transfer from one machine to another), or if you need to send them (e.g.
 to the Q&A team).
 
 Note however that flashing a filesystem image to a device while using the
-sparse mode of +dd+ may result in a broken filesystem (eg. the block bitmap
+sparse mode of +dd+ may result in a broken filesystem (e.g. the block bitmap
 of an ext2 filesystem may be corrupted; or, if you have sparse files in
 your filesystem, those parts may not be all-zeroes when read back). You
 should only use sparse files when handling files on the build machine, not
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 9/9] manual: fix typo in abbreviation 'i.e.'
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
                   ` (7 preceding siblings ...)
  2014-03-28 21:24 ` [Buildroot] [PATCH 8/9] manual: fix typo in abbreviation 'e.g.' Jerzy Grzegorek
@ 2014-03-28 21:24 ` Jerzy Grzegorek
  2014-03-29  8:33 ` [Buildroot] [PATCH 0/9] Documentation cleanup Thomas Petazzoni
  9 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 21:24 UTC (permalink / raw)
  To: buildroot

Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
---
 docs/manual/adding-packages-autotools.txt |    2 +-
 docs/manual/configure.txt                 |   12 ++++++------
 docs/manual/customize-outside-br.txt      |    2 +-
 docs/manual/faq-troubleshooting.txt       |    2 +-
 4 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/docs/manual/adding-packages-autotools.txt b/docs/manual/adding-packages-autotools.txt
index d0c92ff..cc668b5 100644
--- a/docs/manual/adding-packages-autotools.txt
+++ b/docs/manual/adding-packages-autotools.txt
@@ -119,7 +119,7 @@ cases, typical packages will therefore only use a few of them.
   +make+ command. By default, empty.
 
 * +LIBFOO_AUTORECONF+, tells whether the package should
-  be autoreconfigured or not (i.e, if the configure script and
+  be autoreconfigured or not (i.e. if the configure script and
   Makefile.in files should be re-generated by re-running autoconf,
   automake, libtool, etc.). Valid values are +YES+ and
   +NO+. By default, the value is +NO+
diff --git a/docs/manual/configure.txt b/docs/manual/configure.txt
index 869066a..306a12d 100644
--- a/docs/manual/configure.txt
+++ b/docs/manual/configure.txt
@@ -82,7 +82,7 @@ most important ones allow to:
    built. This library provides the interface between userspace
    applications and the Linux kernel. In order to know how to "talk"
    to the Linux kernel, the C library needs to have access to the
-   _Linux kernel headers_ (i.e, the +.h+ files from the kernel), which
+   _Linux kernel headers_ (i.e. the +.h+ files from the kernel), which
    define the interface between userspace and the kernel (system
    calls, data structures, etc.). Since this interface is backward
    compatible, the version of the Linux kernel headers used to build
@@ -97,7 +97,7 @@ most important ones allow to:
  * Change the version of the GCC compiler, binutils and the C library.
 
  * Select a number of toolchain options (uClibc only): whether the
-   toolchain should have largefile support (i.e support for files
+   toolchain should have largefile support (i.e. support for files
    larger than 2 GB on 32 bits systems), IPv6 support, RPC support
    (used mainly for NFS), wide-char support, locale support (for
    internationalization), C++ support or thread support. Depending on
@@ -180,17 +180,17 @@ Buildroot itself. In general, all toolchains that support the
 developers.
 
 We do not support toolchains or SDK generated by OpenEmbedded or
-Yocto, because these toolchains are not pure toolchains (i.e just the
+Yocto, because these toolchains are not pure toolchains (i.e. just the
 compiler, binutils, the C and C++ libraries). Instead these toolchains
 come with a very large set of pre-compiled libraries and
 programs. Therefore, Buildroot cannot import the 'sysroot' of the
 toolchain, as it would contain hundreds of megabytes of pre-compiled
 libraries that are normally built by Buildroot.
 
-We also do not support using the distribution toolchain (i.e the
+We also do not support using the distribution toolchain (i.e. the
 gcc/binutils/C library installed by your distribution) as the
 toolchain to build software for the target. This is because your
-distribution toolchain is not a "pure" toolchain (i.e only with the
+distribution toolchain is not a "pure" toolchain (i.e. only with the
 C/C++ library), so we cannot import it properly into the Buildroot
 build environment. So even if you are building a system for a x86 or
 x86_64 target, you have to generate a cross-compilation toolchain with
@@ -235,7 +235,7 @@ different solutions to handle the +/dev+ directory :
  * The first solution is *Static using device table*. This is the old
    classical way of handling device files in Linux. With this method,
    the device files are persistently stored in the root filesystem
-   (i.e they persist accross reboots), and there is nothing that will
+   (i.e. they persist accross reboots), and there is nothing that will
    automatically create and remove those device files when hardware
    devices are added or removed from the system. Buildroot therefore
    creates a standard set of device files using a _device table_, the
diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt
index 7498940..6ee55a3 100644
--- a/docs/manual/customize-outside-br.txt
+++ b/docs/manual/customize-outside-br.txt
@@ -78,7 +78,7 @@ Or disable the usage of external definitions:
    directories called +board/<boardname>/+ under +BR2_EXTERNAL+. This
    matches the directory structure used within Buildroot.
 
- * One can store package recipes (i.e +Config.in+ and
+ * One can store package recipes (i.e. +Config.in+ and
    +<packagename>.mk+), or even custom configuration options and make
    logic. Buildroot automatically includes +BR2_EXTERNAL/Config.in+ to
    make it appear in the top-level configuration menu, and includes
diff --git a/docs/manual/faq-troubleshooting.txt b/docs/manual/faq-troubleshooting.txt
index a5079e3..473b0e2 100644
--- a/docs/manual/faq-troubleshooting.txt
+++ b/docs/manual/faq-troubleshooting.txt
@@ -138,7 +138,7 @@ is much more complicated than that:
 
  * When a package is unselected from the configuration, it is not
    sufficient to remove just the files it installed. One must also
-   remove all its reverse dependencies (i.e packages relying on it)
+   remove all its reverse dependencies (i.e. packages relying on it)
    and rebuild all those packages. For example, package A depends
    optionally on the OpenSSL library. Both are selected, and Buildroot
    is built. Package A is built with crypto support using OpenSSL.
-- 
1.7.9.5

^ permalink raw reply related	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 2/9] manual/configure.txt: fix typo
  2014-03-28 21:24 ` [Buildroot] [PATCH 2/9] manual/configure.txt: fix typo Jerzy Grzegorek
@ 2014-03-28 21:32   ` Thomas Petazzoni
  2014-03-28 23:01     ` Jerzy Grzegorek
  0 siblings, 1 reply; 22+ messages in thread
From: Thomas Petazzoni @ 2014-03-28 21:32 UTC (permalink / raw)
  To: buildroot

Dear Jerzy Grzegorek,

On Fri, 28 Mar 2014 22:24:43 +0100, Jerzy Grzegorek wrote:
> Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
> ---
>  docs/manual/configure.txt |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/manual/configure.txt b/docs/manual/configure.txt
> index 16c86cc..869066a 100644
> --- a/docs/manual/configure.txt
> +++ b/docs/manual/configure.txt
> @@ -165,7 +165,7 @@ Then, you have three solutions to use an external toolchain:
>    prefix+ and +External toolchain C library+ options. Then, you have
>    to tell Buildroot what your external toolchain supports. If your
>    external toolchain uses the 'glibc' library, you only have to tell
> -  whether your toolchain supports C\+\+ or not and whether it has
> +  whether your toolchain supports C++ or not and whether it has

Have you checked if the rendered files of the manual are still correct
after this? IIRC, these backslashes were needed because ++ is a valid
asciidoc construct.

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

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 2/9] manual/configure.txt: fix typo
  2014-03-28 21:32   ` Thomas Petazzoni
@ 2014-03-28 23:01     ` Jerzy Grzegorek
  0 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-28 23:01 UTC (permalink / raw)
  To: buildroot


Hi Thomas,

> Dear Jerzy Grzegorek,
>
> On Fri, 28 Mar 2014 22:24:43 +0100, Jerzy Grzegorek wrote:
>> Signed-off-by: Jerzy Grzegorek <jerzy.grzegorek@trzebnica.net>
>> ---
>>   docs/manual/configure.txt |    2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/docs/manual/configure.txt b/docs/manual/configure.txt
>> index 16c86cc..869066a 100644
>> --- a/docs/manual/configure.txt
>> +++ b/docs/manual/configure.txt
>> @@ -165,7 +165,7 @@ Then, you have three solutions to use an external toolchain:
>>     prefix+ and +External toolchain C library+ options. Then, you have
>>     to tell Buildroot what your external toolchain supports. If your
>>     external toolchain uses the 'glibc' library, you only have to tell
>> -  whether your toolchain supports C\+\+ or not and whether it has
>> +  whether your toolchain supports C++ or not and whether it has
> Have you checked if the rendered files of the manual are still correct
> after this? IIRC, these backslashes were needed because ++ is a valid
> asciidoc construct.

Ah yes, right. I have removed one slash too much.
It should be:  C\++
Thanks for reviewing.

Regards,
Jerzy

>
> Thomas

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
                   ` (8 preceding siblings ...)
  2014-03-28 21:24 ` [Buildroot] [PATCH 9/9] manual: fix typo in abbreviation 'i.e.' Jerzy Grzegorek
@ 2014-03-29  8:33 ` Thomas Petazzoni
  2014-03-29  9:52   ` Jerzy Grzegorek
  9 siblings, 1 reply; 22+ messages in thread
From: Thomas Petazzoni @ 2014-03-29  8:33 UTC (permalink / raw)
  To: buildroot

Dear Jerzy Grzegorek,

On Fri, 28 Mar 2014 22:24:41 +0100, Jerzy Grzegorek wrote:

> Here is a series that fixes a few typoes and makes small improvements
> in documentation.

I've applied patches 1 to 6, 8 and 9. For patch 2, I made the change we
discussed.

I haven't applied patch 7, because I don't agree with:

+series is introduced by a cover letter, an overall patch version may be
+added to the cover letter in addition/instead to the individual commits.

The version in the title of the cover letter does *not* replace the
version in the title of the patches. Both should be present, so the
"/instead" is not correct. Also, the "may be added" does not seem
right, because a version is always added to the cover letter title by
"git format-patch --subject-prefix".

Best regards,

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

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29  8:33 ` [Buildroot] [PATCH 0/9] Documentation cleanup Thomas Petazzoni
@ 2014-03-29  9:52   ` Jerzy Grzegorek
  2014-03-29 10:28     ` Thomas Petazzoni
  0 siblings, 1 reply; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-29  9:52 UTC (permalink / raw)
  To: buildroot


Hi Thomas,

> Dear Jerzy Grzegorek,
>
> On Fri, 28 Mar 2014 22:24:41 +0100, Jerzy Grzegorek wrote:
>
>> Here is a series that fixes a few typoes and makes small improvements
>> in documentation.
> I've applied patches 1 to 6, 8 and 9. For patch 2, I made the change we
> discussed.
>
> I haven't applied patch 7, because I don't agree with:
>
> +series is introduced by a cover letter, an overall patch version may be
> +added to the cover letter in addition/instead to the individual commits.
>
> The version in the title of the cover letter does *not* replace the
> version in the title of the patches. Both should be present, so the
> "/instead" is not correct. Also, the "may be added" does not seem
> right, because a version is always added to the cover letter title by
> "git format-patch --subject-prefix".

Regarding the "may be added", I agree.
I proposed this change because I saw on mailing list both cases of
submitting patch series introduced by a cover letter:

  * "in addition" case:
     [Patch vX 0/Y] ...
     [Patch vX 1/Y] ...
     ...
     [Patch vX Y/Y] ...

* "instead" case:
     [Patch vX 0/Y] ...
     [Patch 1/Y] ...
     ...
     [Patch Y/Y] ...

but ok, agree.
So maybe it should be:
"Note that when your patch series is introduced by a cover letter,
a patch version should be added to the cover letter in addition to
the individual commits."

Regards,
Jerzy

>
> Best regards,
>
> Thomas

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29  9:52   ` Jerzy Grzegorek
@ 2014-03-29 10:28     ` Thomas Petazzoni
  2014-03-29 10:59       ` Jerzy Grzegorek
  0 siblings, 1 reply; 22+ messages in thread
From: Thomas Petazzoni @ 2014-03-29 10:28 UTC (permalink / raw)
  To: buildroot

Dear Jerzy Grzegorek,

On Sat, 29 Mar 2014 10:52:38 +0100, Jerzy Grzegorek wrote:

> Regarding the "may be added", I agree.
> I proposed this change because I saw on mailing list both cases of
> submitting patch series introduced by a cover letter:
> 
>   * "in addition" case:
>      [Patch vX 0/Y] ...
>      [Patch vX 1/Y] ...
>      ...
>      [Patch vX Y/Y] ...
> 
> * "instead" case:
>      [Patch vX 0/Y] ...
>      [Patch 1/Y] ...
>      ...
>      [Patch Y/Y] ...

To me, this second variant is wrong. This is because the cover letters
are not recorded by patchwork, so if the version is not mentioned in
the title of each individual patch, patchwork will not have the
information of the version of the patches.

> So maybe it should be:
> "Note that when your patch series is introduced by a cover letter,
> a patch version should be added to the cover letter in addition to
> the individual commits."

But is it really necessary? Such a wording seems to imply that the
contributor would have to do this manually, while the contributor
should instead simply use "git format-patch --subject-prefix", which
does just the right thing.

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

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29 10:28     ` Thomas Petazzoni
@ 2014-03-29 10:59       ` Jerzy Grzegorek
  2014-03-29 11:05         ` Thomas Petazzoni
  0 siblings, 1 reply; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-29 10:59 UTC (permalink / raw)
  To: buildroot


Hi Thomas,

> Dear Jerzy Grzegorek,
>
> On Sat, 29 Mar 2014 10:52:38 +0100, Jerzy Grzegorek wrote:
>
>> Regarding the "may be added", I agree.
>> I proposed this change because I saw on mailing list both cases of
>> submitting patch series introduced by a cover letter:
>>
>>    * "in addition" case:
>>       [Patch vX 0/Y] ...
>>       [Patch vX 1/Y] ...
>>       ...
>>       [Patch vX Y/Y] ...
>>
>> * "instead" case:
>>       [Patch vX 0/Y] ...
>>       [Patch 1/Y] ...
>>       ...
>>       [Patch Y/Y] ...
> To me, this second variant is wrong. This is because the cover letters
> are not recorded by patchwork, so if the version is not mentioned in
> the title of each individual patch, patchwork will not have the
> information of the version of the patches.
>
>> So maybe it should be:
>> "Note that when your patch series is introduced by a cover letter,
>> a patch version should be added to the cover letter in addition to
>> the individual commits."
> But is it really necessary? Such a wording seems to imply that the
> contributor would have to do this manually, while the contributor
> should instead simply use "git format-patch --subject-prefix", which
> does just the right thing.

Ok, agree.
You haven't changed
C++  -->  C\++
for my patch 2.

Regards,
Jerzy

>
> Thomas

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29 10:59       ` Jerzy Grzegorek
@ 2014-03-29 11:05         ` Thomas Petazzoni
  2014-03-29 11:17           ` Yann E. MORIN
  2014-03-29 11:46           ` Jerzy Grzegorek
  0 siblings, 2 replies; 22+ messages in thread
From: Thomas Petazzoni @ 2014-03-29 11:05 UTC (permalink / raw)
  To: buildroot

Dear Jerzy Grzegorek,

On Sat, 29 Mar 2014 11:59:26 +0100, Jerzy Grzegorek wrote:

> Ok, agree.

Ok, thanks!

> You haven't changed
> C++  -->  C\++
> for my patch 2.

Huh ? See
http://git.buildroot.net/buildroot/commit/?id=082dec8ce440236b1477e568f0965f05ad241adb

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

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29 11:05         ` Thomas Petazzoni
@ 2014-03-29 11:17           ` Yann E. MORIN
  2014-03-29 11:36             ` Thomas Petazzoni
  2014-03-29 11:46           ` Jerzy Grzegorek
  1 sibling, 1 reply; 22+ messages in thread
From: Yann E. MORIN @ 2014-03-29 11:17 UTC (permalink / raw)
  To: buildroot

Thomas, All,

On 2014-03-29 12:05 +0100, Thomas Petazzoni spake thusly:
> On Sat, 29 Mar 2014 11:59:26 +0100, Jerzy Grzegorek wrote:
> 
> > Ok, agree.
> 
> Ok, thanks!
> 
> > You haven't changed
> > C++  -->  C\++
> > for my patch 2.
> 
> Huh ? See
> http://git.buildroot.net/buildroot/commit/?id=082dec8ce440236b1477e568f0965f05ad241adb

You missed one of the two changes.

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.  |
'------------------------------^-------^------------------^--------------------'

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29 11:17           ` Yann E. MORIN
@ 2014-03-29 11:36             ` Thomas Petazzoni
  0 siblings, 0 replies; 22+ messages in thread
From: Thomas Petazzoni @ 2014-03-29 11:36 UTC (permalink / raw)
  To: buildroot

Dear Yann E. MORIN,

On Sat, 29 Mar 2014 12:17:29 +0100, Yann E. MORIN wrote:

> > > You haven't changed
> > > C++  -->  C\++
> > > for my patch 2.
> > 
> > Huh ? See
> > http://git.buildroot.net/buildroot/commit/?id=082dec8ce440236b1477e568f0965f05ad241adb
> 
> You missed one of the two changes.

Arghh, indeed.

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

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29 11:05         ` Thomas Petazzoni
  2014-03-29 11:17           ` Yann E. MORIN
@ 2014-03-29 11:46           ` Jerzy Grzegorek
  2014-03-29 13:28             ` Thomas Petazzoni
  1 sibling, 1 reply; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-29 11:46 UTC (permalink / raw)
  To: buildroot


Hi Thomas,

> Dear Jerzy Grzegorek,
>
> On Sat, 29 Mar 2014 11:59:26 +0100, Jerzy Grzegorek wrote:
>
>> Ok, agree.
> Ok, thanks!
>
>> You haven't changed
>> C++  -->  C\++
>> for my patch 2.
> Huh ? See
> http://git.buildroot.net/buildroot/commit/?id=082dec8ce440236b1477e568f0965f05ad241adb

My patach should change only
C\+\+  -->   C\++

-  whether your toolchain supports C\+\+ or not and whether it has
+  whether your toolchain supports C\++ or not and whether it has



Regards,
Jerzy

>
> Thmas

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29 11:46           ` Jerzy Grzegorek
@ 2014-03-29 13:28             ` Thomas Petazzoni
  2014-03-30 21:52               ` Jerzy Grzegorek
  0 siblings, 1 reply; 22+ messages in thread
From: Thomas Petazzoni @ 2014-03-29 13:28 UTC (permalink / raw)
  To: buildroot

Dear Jerzy Grzegorek,

On Sat, 29 Mar 2014 12:46:19 +0100, Jerzy Grzegorek wrote:
> 
> Hi Thomas,
> 
> > Dear Jerzy Grzegorek,
> >
> > On Sat, 29 Mar 2014 11:59:26 +0100, Jerzy Grzegorek wrote:
> >
> >> Ok, agree.
> > Ok, thanks!
> >
> >> You haven't changed
> >> C++  -->  C\++
> >> for my patch 2.
> > Huh ? See
> > http://git.buildroot.net/buildroot/commit/?id=082dec8ce440236b1477e568f0965f05ad241adb
> 
> My patach should change only
> C\+\+  -->   C\++
> 
> -  whether your toolchain supports C\+\+ or not and whether it has
> +  whether your toolchain supports C\++ or not and whether it has

I believe C++ should also be fixed to C\++, no?

In any case, can you send a corrective patch?

Thanks!

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

^ permalink raw reply	[flat|nested] 22+ messages in thread

* [Buildroot] [PATCH 0/9] Documentation cleanup
  2014-03-29 13:28             ` Thomas Petazzoni
@ 2014-03-30 21:52               ` Jerzy Grzegorek
  0 siblings, 0 replies; 22+ messages in thread
From: Jerzy Grzegorek @ 2014-03-30 21:52 UTC (permalink / raw)
  To: buildroot


Hi Thomas,

> Dear Jerzy Grzegorek,
>
> On Sat, 29 Mar 2014 12:46:19 +0100, Jerzy Grzegorek wrote:
>> Hi Thomas,
>>
>>> Dear Jerzy Grzegorek,
>>>
>>> On Sat, 29 Mar 2014 11:59:26 +0100, Jerzy Grzegorek wrote:
>>>
>>>> Ok, agree.
>>> Ok, thanks!
>>>
>>>> You haven't changed
>>>> C++  -->  C\++
>>>> for my patch 2.
>>> Huh ? See
>>> http://git.buildroot.net/buildroot/commit/?id=082dec8ce440236b1477e568f0965f05ad241adb
>> My patach should change only
>> C\+\+  -->   C\++
>>
>> -  whether your toolchain supports C\+\+ or not and whether it has
>> +  whether your toolchain supports C\++ or not and whether it has
> I believe C++ should also be fixed to C\++, no?

No, only C\+\+ should be changed to C\++.

>
> In any case, can you send a corrective patch?

Yes, of course.

Regards,
Jerzy

>
> Thanks!
>
> Thomas

^ permalink raw reply	[flat|nested] 22+ messages in thread

end of thread, other threads:[~2014-03-30 21:52 UTC | newest]

Thread overview: 22+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-03-28 21:24 [Buildroot] [PATCH 0/9] Documentation cleanup Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 1/9] manual/configure.txt: reword part about internal toolchain backend Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 2/9] manual/configure.txt: fix typo Jerzy Grzegorek
2014-03-28 21:32   ` Thomas Petazzoni
2014-03-28 23:01     ` Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 3/9] manual/make-tips.txt: " Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 4/9] manual/contribute.txt: " Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 5/9] manual/contribute.txt: reword part about reporting issues Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 6/9] manual/legal-notice.txt: fix typo Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 7/9] manual/contribute.txt: reword part about versioning patches Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 8/9] manual: fix typo in abbreviation 'e.g.' Jerzy Grzegorek
2014-03-28 21:24 ` [Buildroot] [PATCH 9/9] manual: fix typo in abbreviation 'i.e.' Jerzy Grzegorek
2014-03-29  8:33 ` [Buildroot] [PATCH 0/9] Documentation cleanup Thomas Petazzoni
2014-03-29  9:52   ` Jerzy Grzegorek
2014-03-29 10:28     ` Thomas Petazzoni
2014-03-29 10:59       ` Jerzy Grzegorek
2014-03-29 11:05         ` Thomas Petazzoni
2014-03-29 11:17           ` Yann E. MORIN
2014-03-29 11:36             ` Thomas Petazzoni
2014-03-29 11:46           ` Jerzy Grzegorek
2014-03-29 13:28             ` Thomas Petazzoni
2014-03-30 21:52               ` Jerzy Grzegorek

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.