missing colon delimiters in style.9
Index: style.9 === RCS file: /cvs/src/share/man/man9/style.9,v retrieving revision 1.62 diff -u -p -r1.62 style.9 --- style.9 5 Oct 2015 01:22:34 - 1.62 +++ style.9 5 Oct 2015 11:41:35 - @@ -471,12 +471,12 @@ is volatile, but is not. To make .Dq *foo -volatile use the syntax +volatile use the syntax: .Bd -literal -offset indent volatile char *foo; .Ed .Pp -If both the pointer and the thing pointed to are volatile use +If both the pointer and the thing pointed to are volatile use: .Bd -literal -offset indent volatile char *volatile foo; .Ed @@ -506,11 +506,11 @@ functions where the compiler does not kn .Pp Don't use .Ql \&! -for tests unless it's a boolean, i.e., use +for tests unless it's a boolean, i.e., use: .Bd -literal -offset indent if (*p == '\e0') .Ed -not +not: .Bd -literal -offset indent -compact if (!*p) .Ed
Re: missing colon delimiters in style.9
On Sun, Oct 04, 2015 at 10:56:45PM -0400, Rob Pierce wrote: > > Index: style.9 > === there are many more places in this place you'd have to add colons if you wanted to do it consistently. generally i do use colons for stuff like this but that's really a matter of preference. this page has so many indented examples we'd be drowning if we added them everywhere. i don;t think this is worthwhile. jmc > RCS file: /cvs/src/share/man/man9/style.9,v > retrieving revision 1.62 > diff -u -p -r1.62 style.9 > --- style.9 5 Oct 2015 01:22:34 - 1.62 > +++ style.9 5 Oct 2015 11:41:35 - > @@ -471,12 +471,12 @@ is volatile, but > is not. > To make > .Dq *foo > -volatile use the syntax > +volatile use the syntax: > .Bd -literal -offset indent > volatile char *foo; > .Ed > .Pp > -If both the pointer and the thing pointed to are volatile use > +If both the pointer and the thing pointed to are volatile use: > .Bd -literal -offset indent > volatile char *volatile foo; > .Ed > @@ -506,11 +506,11 @@ functions where the compiler does not kn > .Pp > Don't use > .Ql \&! > -for tests unless it's a boolean, i.e., use > +for tests unless it's a boolean, i.e., use: > .Bd -literal -offset indent > if (*p == '\e0') > .Ed > -not > +not: > .Bd -literal -offset indent -compact > if (!*p) > .Ed >
Re: missing colon delimiters in style.9
On Mon, Oct 05, 2015 at 03:18:06PM +0100, Jason McIntyre wrote: > On Sun, Oct 04, 2015 at 10:56:45PM -0400, Rob Pierce wrote: > > > > Index: style.9 > > === > > there are many more places in this place you'd have to add colons if you > wanted to do it consistently. generally i do use colons for stuff like > this but that's really a matter of preference. this page has so many > indented examples we'd be drowning if we added them everywhere. > > i don;t think this is worthwhile. > > jmc Hey Jason, If you mean colons versus periods and commas then I agree. However, these few sentences are the only ones with no ending punctuation at all (I found one more offender and included it below). They stuck out to me, and given that it is a "style" guide that will be read by new folks I thought it worth mentioning. Regards, Index: style.9 === RCS file: /cvs/src/share/man/man9/style.9,v retrieving revision 1.62 diff -u -p -r1.62 style.9 --- style.9 5 Oct 2015 01:22:34 - 1.62 +++ style.9 5 Oct 2015 15:15:53 - @@ -441,7 +441,7 @@ in a program, the or .Fl Wall flag should be used to verify that the compiler does not generate -warnings such as +warnings such as: .Bd -literal -offset indent warning: variable `foo' might be clobbered by `longjmp' or `vfork'. .Ed @@ -471,12 +471,12 @@ is volatile, but is not. To make .Dq *foo -volatile use the syntax +volatile use the syntax: .Bd -literal -offset indent volatile char *foo; .Ed .Pp -If both the pointer and the thing pointed to are volatile use +If both the pointer and the thing pointed to are volatile use: .Bd -literal -offset indent volatile char *volatile foo; .Ed @@ -506,11 +506,11 @@ functions where the compiler does not kn .Pp Don't use .Ql \&! -for tests unless it's a boolean, i.e., use +for tests unless it's a boolean, i.e., use: .Bd -literal -offset indent if (*p == '\e0') .Ed -not +not: .Bd -literal -offset indent -compact if (!*p) .Ed
Re: missing colon delimiters in style.9
- Original Message - > From: "Jason McIntyre" <j...@kerhand.co.uk> > To: "tech" <tech@openbsd.org> > Sent: Monday, October 5, 2015 11:41:57 AM > Subject: Re: missing colon delimiters in style.9 > On Mon, Oct 05, 2015 at 11:21:24AM -0400, Rob Pierce wrote: >> On Mon, Oct 05, 2015 at 03:18:06PM +0100, Jason McIntyre wrote: >> > On Sun, Oct 04, 2015 at 10:56:45PM -0400, Rob Pierce wrote: >> > > >> > > Index: style.9 >> > > === >> > >> > there are many more places in this place you'd have to add colons if you >> > wanted to do it consistently. generally i do use colons for stuff like >> > this but that's really a matter of preference. this page has so many >> > indented examples we'd be drowning if we added them everywhere. >> > >> > i don;t think this is worthwhile. >> > >> > jmc >> >> Hey Jason, >> >> If you mean colons versus periods and commas then I agree. However, these few >> sentences are the only ones with no ending punctuation at all (I found one >> more offender and included it below). >> >> They stuck out to me, and given that it is a "style" guide that will be read >> by new folks I thought it worth mentioning. >> >> Regards, >> > > it's just treating the example as a continuation of the text, that's > all. the notation is used all over the place. i honestly don;t think > it's worth worrying about. > > jmc Roger that, thanks.
Re: missing colon delimiters in style.9
On Mon, Oct 05, 2015 at 11:21:24AM -0400, Rob Pierce wrote: > On Mon, Oct 05, 2015 at 03:18:06PM +0100, Jason McIntyre wrote: > > On Sun, Oct 04, 2015 at 10:56:45PM -0400, Rob Pierce wrote: > > > > > > Index: style.9 > > > === > > > > there are many more places in this place you'd have to add colons if you > > wanted to do it consistently. generally i do use colons for stuff like > > this but that's really a matter of preference. this page has so many > > indented examples we'd be drowning if we added them everywhere. > > > > i don;t think this is worthwhile. > > > > jmc > > Hey Jason, > > If you mean colons versus periods and commas then I agree. However, these few > sentences are the only ones with no ending punctuation at all (I found one > more offender and included it below). > > They stuck out to me, and given that it is a "style" guide that will be read > by new folks I thought it worth mentioning. > > Regards, > it's just treating the example as a continuation of the text, that's all. the notation is used all over the place. i honestly don;t think it's worth worrying about. jmc > Index: style.9 > === > RCS file: /cvs/src/share/man/man9/style.9,v > retrieving revision 1.62 > diff -u -p -r1.62 style.9 > --- style.9 5 Oct 2015 01:22:34 - 1.62 > +++ style.9 5 Oct 2015 15:15:53 - > @@ -441,7 +441,7 @@ in a program, the > or > .Fl Wall > flag should be used to verify that the compiler does not generate > -warnings such as > +warnings such as: > .Bd -literal -offset indent > warning: variable `foo' might be clobbered by `longjmp' or `vfork'. > .Ed > @@ -471,12 +471,12 @@ is volatile, but > is not. > To make > .Dq *foo > -volatile use the syntax > +volatile use the syntax: > .Bd -literal -offset indent > volatile char *foo; > .Ed > .Pp > -If both the pointer and the thing pointed to are volatile use > +If both the pointer and the thing pointed to are volatile use: > .Bd -literal -offset indent > volatile char *volatile foo; > .Ed > @@ -506,11 +506,11 @@ functions where the compiler does not kn > .Pp > Don't use > .Ql \&! > -for tests unless it's a boolean, i.e., use > +for tests unless it's a boolean, i.e., use: > .Bd -literal -offset indent > if (*p == '\e0') > .Ed > -not > +not: > .Bd -literal -offset indent -compact > if (!*p) > .Ed >
