doc: correct some spelling

Commit Message

Ramsay Jones June 14, 2020, 7:36 p.m. UTC

Signed-off-by: Ramsay Jones <[e-mail]>
---

Hi Luc,

The only spelling fixes in the manpage are s/exemple/example/,
s/trigered/triggered/ and s/&/and/. I would not normally change
any 'formatting' in sparse.1, but the '{ 0 }' and '{ }' got
split across line-endings, so I removed the spaces.
(other solutions are possible ...)

ATB,
Ramsay Jones

 Documentation/release-notes/v0.6.2.rst |  8 ++++----
 sparse.1                               | 10 +++++-----
 2 files changed, 9 insertions(+), 9 deletions(-)

Comments

Luc Van Oostenryck June 14, 2020, 10:05 p.m. UTC | #1

On Sun, Jun 14, 2020 at 08:36:38PM +0100, Ramsay Jones wrote:
> Signed-off-by: Ramsay Jones <[e-mail]>
> 
> The only spelling fixes in the manpage are s/exemple/example/,
> s/trigered/triggered/ and s/&/and/. I would not normally change
> any 'formatting' in sparse.1, but the '{ 0 }' and '{ }' got
> split across line-endings, so I removed the spaces.
> (other solutions are possible ...)

Thank you again for noticing and fixing these typos.

Yes, the formatting is often very bad on the man page
because of bad or missing linebreaks.
I changed this part of your patch to use a non-breakable
space for the '{ 0 }' and '{ }'. They look, I think, better.

-- Luc

Ramsay Jones June 14, 2020, 11:42 p.m. UTC | #2

On 14/06/2020 23:05, Luc Van Oostenryck wrote:
> On Sun, Jun 14, 2020 at 08:36:38PM +0100, Ramsay Jones wrote:
>> Signed-off-by: Ramsay Jones <[e-mail]>
>>
>> The only spelling fixes in the manpage are s/exemple/example/,
>> s/trigered/triggered/ and s/&/and/. I would not normally change
>> any 'formatting' in sparse.1, but the '{ 0 }' and '{ }' got
>> split across line-endings, so I removed the spaces.
>> (other solutions are possible ...)
> 
> Thank you again for noticing and fixing these typos.
> 
> Yes, the formatting is often very bad on the man page
> because of bad or missing linebreaks.
> I changed this part of your patch to use a non-breakable
> space for the '{ 0 }' and '{ }'. They look, I think, better.

Yeah, I tried a nbsp too (that was part of my 'other solutions'), and
compared the two outputs; there wasn't much difference in the output
so I went with the 'easier' patch. ;-)

This looks good. (I see you noticed a couple more ...)

ATB,
Ramsay Jones

Patch

diff --git a/Documentation/release-notes/v0.6.2.rst b/Documentation/release-notes/v0.6.2.rst
index 0ef67fc5..7439724c 100644
--- a/Documentation/release-notes/v0.6.2.rst
+++ b/Documentation/release-notes/v0.6.2.rst
@@ -10,7 +10,7 @@  V0.6.2
 * add support for _Generic
 
 * fully propagate declarations downward
-  For exemple, it means that code like:
+  For example, it means that code like:
 
         static int foo(void);
         int foo(void) { return 0; }
@@ -21,7 +21,7 @@  V0.6.2
   * allow a single sparse executable to be used for multiple architectures
   * add support for -mcmodel & -f{pic,PIC,pie,PIE}, mainly for RISC-V
   * add new option, --arch=$ARCH, to specify the target architecture
-  * move all arch-specifc code in separated files (target-$ARCH.c) 
+  * move all arch-specific code into separate files (target-$ARCH.c)
   * try to support the various floating-point ABIs on ARM
   * fix wchar_t & wint_t for openbsd
   * add missing predefines for PPC
@@ -72,7 +72,7 @@  V0.6.2
   * define _BIG_ENDIAN when needed
   * remove definition of _STRING_ARCH_unaligned (defined by glibc)
   * removed unneeded predefines for integers (now defined by sparse)
-  * better mult-arch support by using --arch=$ARCH
+  * better multi-arch support by using --arch=$ARCH
 
 * testsuite:
   * avoid standard includes in the tests
@@ -90,7 +90,7 @@  V0.6.2
 
 * misc:
   * add support for '-std=c17/c18'
-  * simplify testng of which version of the standard is used
+  * simplify testing of which version of the standard is used
   * various improvements to the 'dissect' tool
   * simplify the parsing of type specifiers
   * improve diagnostic messages concerning bitfields
diff --git a/sparse.1 b/sparse.1
index bbcffc41..e8994a66 100644
--- a/sparse.1
+++ b/sparse.1
@@ -437,20 +437,20 @@  Sparse does not issue these warnings by default.
 .
 .TP
 .B \-Wuniversal\-initializer
-Do not suppress warnings caused by using '{ 0 }' instead of '{ }' on
+Do not suppress warnings caused by using '{0}' instead of '{}' on
 aggregate types, ignoring its special status as universal initializer.
-The concerned warnings are, for exemple, those trigered by
+The concerned warnings are, for example, those triggered by
 \fB\-Wdesignated\-init\fR or \fB\-Wnon\-pointer\-null\fR.
 
-Sparse does not issue these warnings by default, processing '{ 0 }'
-the same as '{ }'.
+Sparse does not issue these warnings by default, processing '{0}'
+the same as '{}'.
 .
 .SH MISC OPTIONS
 .TP
 .B \-\-arch=\fIARCH\fR
 Specify the target architecture.
 For architectures having both a 32-bit and a 64-bit variant (mips, powerpc,
-riscv & sparc) the architecture name can be suffixed with \fI32\fR or \fI64\fR.
+riscv and sparc) the architecture name can be suffixed with \fI32\fR or \fI64\fR.
 
 The default architecture & size is the one of the machine used to build Sparse.
 .