Re: [diffs] www/ and www/faq/ tweaks (punctuation and typo fixes)
Nick Holland <[email protected]>
| Newsgroups | gmane.os.openbsd.www |
|---|---|
| Message-ID | <[email protected]> |
Alan R. S. Bueno wrote: > On Fri, Sep 4, 2009 at 2:08 PM, Theo de Raadt<[email protected]> wrote: >> Cannot apply mangled diffs. >> >> Content-Type: text/plain; charset=ISO-8859-1 >> >> As in, you line wrapped them. I don't understand where this world is headed > to, >> where straight text diffs are mailed in which then cannot be applied. >> >> > > I'm attaching the diffs now. I don't sent them previously due to > connection problems here. Sorry for the noise. > Index: faq10.html > =================================================================== > RCS file: /cvs/www/faq/faq10.html,v > retrieving revision 1.144 > diff -u faq10.html > --- faq10.html 23 May 2009 11:34:24 -0000 1.144 > +++ faq10.html 4 Sep 2009 17:56:38 -0000 > @@ -205,9 +205,9 @@ > <p> > Here you can obviously see that starting up httpd normally no flags are > necessary. So a line like: "<b> httpd_flags=""</b>" would be > -necessary. But to start httpd with ssl enabled. (Refer to the > -<a href="#HTTPS">SSL FAQ</a> or <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ssl&sektion=8">ssl(8)</a>) > -You should start with a line like: "httpd_flags="-DSSL"". > +necessary. But to start httpd with ssl enabled (refer to the > +<a href="#HTTPS">SSL FAQ</a> or <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ssl&sektion=8">ssl(8)</a>), > +you should start with a line like: "httpd_flags="-DSSL"". > > <p> > A good approach is to never touch <i>/etc/rc.conf</i> itself. Instead, you are right on this, BUT this article needs a rework, and the four chars you changed is not worth making the translation team jump twice for. > Index: faq12.html > =================================================================== yep. > Index: faq13.html > =================================================================== yep. > Index: faq2.html > =================================================================== yep. > Index: faq4.html > =================================================================== > RCS file: /cvs/www/faq/faq4.html,v > retrieving revision 1.283 > diff -u faq4.html > --- faq4.html 24 Aug 2009 10:26:18 -0000 1.283 > +++ faq4.html 4 Sep 2009 17:57:53 -0000 > @@ -494,7 +494,7 @@ > don't have a new command mode. > In this case, you need to experiment.) > If you have multiple CD-ROM devices, you need to boot from the correct one. > -try <tt>probe-scsi</tt> (or <tt>probe-ide</tt> on newer systems) from > +Try <tt>probe-scsi</tt> (or <tt>probe-ide</tt> on newer systems) from > the new command mode. yes...well, what was there was wrong. I went for joining the sentences with a semicolon instead. > <p> > @@ -1989,7 +1989,7 @@ > When you reboot, you should be able to select OpenBSD from the NT loader > menu. There is much more information available about NTLDR at the > <a href="http://www.tburke.net/info/ntldr/ntldr_hacking_guide.htm">NTLDR > -Hacking Guide.</a> > +Hacking Guide</a>. yes. > <p> > On Windows XP you can also edit the boot information using the GUI; see the > @@ -2000,7 +2000,7 @@ > <a href="http://www.winimage.com/bootpart.htm">BootPart</a>. > This program can be run from Windows NT/2000/XP, and will fetch > the OpenBSD PBR, place it on your NT/2000/XP partition, and will > -add it to <tt>C:\BOOT.INI</tt> > +add it to <tt>C:\BOOT.INI</tt>. yes > <p> > Note: The Windows NT/2000/XP boot loader is only capable of booting OSs > @@ -2011,10 +2011,10 @@ > > <p> > With Vista, Microsoft dropped NTLDR support in favor of their newer Boot > -Configuration Data (BCD) store used for controlling the boot > -environment. Since <tt>BOOT.INI</tt> is no longer available for > -customization, a command-line utility, <tt>bcdedit</tt>, takes its > -place. > +Configuration Data (BCD) store used for controlling the boot > +environment. Since <tt>BOOT.INI</tt> is no longer available for > +customization, a command-line utility, <tt>bcdedit</tt>, takes its > +place. yuck. White space. I don't like white space diffs. Why? 1) looking at the diff on the screen and trying to figure out if it is a subtle transposition of characters or a missing or incorrect punctuation character has got to be hell for the translators. I know it was not fun for me to figure out it was a white space diff in with punctuation diffs. IF we are going to do white space diffs, they should be completely separate from any other diff, so we can say to the translation team, "Whitespace ONLY, feel free to ignore". 2) The other big problem with whitespace diffs is I'll end up creating new whitespace problems in the future. It will be a never-ending battle, and it just isn't worth it. So...no, I don't like whitespace diffs. I almost re-wrapped this section for new-line, new sentence, seems I forgot to do that when it was committed. :( also... faq4 is about to be VERY SIGNIFICANTLY reworked for 4.6, so the translators will have enough (re)work to do... > @@ -2031,9 +2031,9 @@ no, whitespace. > @@ -2053,14 +2053,14 @@ no, whitespace. > @@ -2072,12 +2072,12 @@ no, whitespace > @@ -2090,7 +2090,7 @@ > multiboot environment with OpenBSD. > > <p> > -After copying OpenBSD's PBR into Window 7's system partition, issue > +After copying OpenBSD's PBR into Windows 7's system partition, issue > the following command to initialize the needed registry hive: > > <p> yes > @@ -2103,8 +2103,8 @@ whitespace > @@ -2132,10 +2132,10 @@ whitespace. > <h3>OpenBSD and Linux (i386)</h3> > Index: faq5.html > =================================================================== > RCS file: /cvs/www/faq/faq5.html,v > retrieving revision 1.172 > diff -u faq5.html > --- faq5.html 1 Sep 2009 00:39:14 -0000 1.172 > +++ faq5.html 4 Sep 2009 17:58:03 -0000 > @@ -1324,9 +1324,10 @@ > via <b>boot -c</b>, you will need these changes to be written out > permanently. To do this you need to use the <b>-u</b> option. > In the following example, the computer was booted into the UKC and the > -wi(4) device was disabled. Since changes made with boot -c are NOT > -permanent, these changes must be written out. This example writes the > -changes made from boot -c into a new kernel binary bsd.new. > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=wi&sektion=4">wi(4)</a> > +device was disabled. Since changes made with boot -c are NOT permanent, > +these changes must be written out. This example writes the changes made > +from boot -c into a new kernel binary bsd.new. > > <blockquote><pre> > $ <strong>sudo config -e -u -o bsd.new /bsd</strong> Here's my diff instead: Index: faq5.html =================================================================== RCS file: /cvs/www/faq/faq5.html,v retrieving revision 1.172 diff -u -r1.172 faq5.html --- faq5.html 1 Sep 2009 00:39:14 -0000 1.172 +++ faq5.html 9 Sep 2009 01:30:45 -0000 @@ -1324,7 +1324,8 @@ via <b>boot -c</b>, you will need these changes to be written out permanently. To do this you need to use the <b>-u</b> option. In the following example, the computer was booted into the UKC and the -wi(4) device was disabled. Since changes made with boot -c are NOT +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=wi&sektion=4">wi(4)</a> +device was disabled. Since changes made with boot -c are NOT permanent, these changes must be written out. This example writes the changes made from boot -c into a new kernel binary bsd.new. Note that by not rewrapping everything, I eliminated four lines of change, hopefully making the translator's life a bit easier. I wish that section was done with "new sentence, new line", which would have further reduced the amount of comparison needed. > Index: faq6.html > =================================================================== > RCS file: /cvs/www/faq/faq6.html,v > retrieving revision 1.277 > diff -u faq6.html > --- faq6.html 2 Jul 2009 11:35:51 -0000 1.277 > +++ faq6.html 4 Sep 2009 17:58:41 -0000 > @@ -1043,17 +1043,19 @@ > <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sysctl&sektion=8">sysctl(8)</a>: > > <pre> > -Set the list of reserved TCP ports that should not be allocated by the > -kernel dynamically. This can be used to keep daemons from stealing a > -specific port that another program needs to function. List elements may > -be separated by commas and/or whitespace. > +To set the list of reserved TCP ports that should not be allocated by the > +kernel dynamically: > > - # <b>sysctl net.inet.tcp.baddynamic=749,750,751,760,761,871</b> > + # <b>sysctl net.inet.tcp.baddynamic=749,750,751,760,761,871</b> > > -It is also possible to add or remove ports from the current list. > +This can be used to keep daemons from stealing a specific port that an- > +other program needs to function. List elements may be separated by com- > +mas and/or whitespace. > > - # <b>sysctl net.inet.tcp.baddynamic=+748</b> > - # <b>sysctl net.inet.tcp.baddynamic=-871</b> > +It is also possible to add or remove ports from the current list: > + > + # <b>sysctl net.inet.tcp.baddynamic=+748</b> > + # <b>sysctl net.inet.tcp.baddynamic=-871</b> > </pre> > yes, but... I also took the opportunity to improve things here by sticking the quoted section in <blockquote> tags and adding #EXAMPLES to the link so that it would be easier found in the man page. > <p> > @@ -1830,7 +1832,7 @@ whitespace > Index: faq7.html > =================================================================== > RCS file: /cvs/www/faq/faq7.html,v > retrieving revision 1.79 > diff -u faq7.html > --- faq7.html 18 Jul 2009 20:11:50 -0000 1.79 > +++ faq7.html 4 Sep 2009 17:58:52 -0000 > @@ -359,7 +359,7 @@ > <ul> > <li>OpenBSD numbers the serial ports starting at <i>tty00</i>, > DOS/Windows labels them starting at <i>COM1</i>. So, keep in mind > -<i>tty02</i> is <i>COM3</i>, not <i>COM2</i> > +<i>tty02</i> is <i>COM3</i>, not <i>COM2</i>. > > <li>Some systems may be able to operate without a video card in the > machine, but certainly not all -- many systems consider this an error yes...but this is one of the cases where whitespace diffs annoy me, because I looked at this a few times before I realized it WASN'T a whitespace diff. > @@ -1830,7 +1832,7 @@ > <p>Let's add another layer of complexity; we want <i>rachael</i> to stay > master when possible. > There are several reasons we might want this: hardware differences, > -simple prejudice, "if this system isn't master, there's a problem," or > +simple prejudice, "if this system isn't master, there's a problem", or > knowing the default master without doing scripting to parse and email > the output of ifconfig. TECHNICALLY, at least as they were teaching English in the Midwestern and southern US about 30 years ago, the way it was is correct. I don't like that style, I much prefer ", to ," when closing a quote. I *think* I talked to my one of my two favorite authorities on proper English language usage (jmc@ and/or tom@), and they indicated my preferred way (as you propose changing it) is acceptable, not sure if that is a "now" or "the people of the UK are less stupid about commas and quotes" thing (or I could be hallucinating, and no such conversation took place). Still, as it is is not wrong, so I'm sticking with the original author's way of doing it rather than making a trivial change that someone else may think should be better as it was and they change it back in a month. > Index: faq8.html > =================================================================== > RCS file: /cvs/www/faq/faq8.html,v > retrieving revision 1.213 > diff -u faq8.html > --- faq8.html 30 Apr 2009 17:19:11 -0000 1.213 > +++ faq8.html 4 Sep 2009 17:59:02 -0000 > @@ -29,7 +29,7 @@ > <p> > <h3>Table of Contents</h3> > <ul> > -<li><a href= "#LostPW" >8.1 - I forgot my root password..... What > +<li><a href= "#LostPW" >8.1 - I forgot my root password... What > do I do now?</a> actually, neither of those match how the article is titled, so I went with the article title. > <li><a href= "#X" >8.2 - X won't start, I get lots of error > messages</a> > @@ -1166,14 +1166,14 @@ > Why is it taking so long for me to log in?</h2> > <p> > Many new users to OpenBSD experience a two minute login delay when using > -services such as > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ssh&sektion=1">ssh,</a> > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp&sektion=1">ftp,</a> or > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=telnet&sektion=1">telnet.</a> > -This can also be experienced when using a proxy, such as > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp-proxy&sektion=8">ftp-proxy,</a> > -or when sending mail out from a workstation through > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sendmail&sektion=8">sendmail.</a> > +services such as > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ssh&sektion=1">ssh</a>, > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp&sektion=1">ftp</a>, or > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=telnet&sektion=1">telnet</a>. > +This can also be experienced when using a proxy, such as > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp-proxy&sektion=8">ftp-proxy</a>, > +or when sending mail out from a workstation through > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sendmail&sektion=8">sendmail</a>. > <p> > This is almost always due to a reverse-DNS problem. DNS is Domain Name > Services, the system the Internet uses to convert a name, such as > @@ -1181,14 +1181,14 @@ > the ability to take a numeric address and convert it back to a "name", > this is "Reverse DNS". > <p> > -In order to provide better logging, OpenBSD performs a reverse-DNS > -lookup on any machine that attaches to it in many different ways, > -including > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ssh&sektion=1">ssh,</a> > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp&sektion=1">ftp,</a> > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=telnet&sektion=1">telnet,</a> > +In order to provide better logging, OpenBSD performs a reverse-DNS > +lookup on any machine that attaches to it in many different ways, > +including > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ssh&sektion=1">ssh</a>, > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp&sektion=1">ftp</a>, > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=telnet&sektion=1">telnet</a>, > <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sendmail&sektion=8">sendmail</a> or > -<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp-proxy&sektion=8">ftp-proxy.</a> > +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=ftp-proxy&sektion=8">ftp-proxy</a>. > Unfortunately, in some cases, the machine that is making the connection > does not have a proper reverse DNS entry. huh. I think I wrote this section, why are all the commas in the wrong place? I know better than that. Anyway...punctuation fixes good, white space mixed in, bad. I think my resulting diff is easier to figure out. Also...telnet is long dead as a login technique for OpenBSD. > Index: cvsup.html > =================================================================== > RCS file: /cvs/www/cvsup.html,v > retrieving revision 1.120 > diff -u cvsup.html > --- cvsup.html 2 Sep 2009 13:23:15 -0000 1.120 > +++ cvsup.html 4 Sep 2009 18:01:29 -0000 > @@ -68,7 +68,7 @@ > <ul> > <li><b>src</b> - Houses all source code for the OpenBSD Operating System.</li> > <li><b>ports</b> - Houses the <a href="./ports.html">OpenBSD Ports</a>.</li> > - <li><b>www</b> - Houses all OpenBSD web pages. (Including this one).</li> > + <li><b>www</b> - Houses all OpenBSD web pages. (Including this one.)</li> > <li><b>X11</b> - Houses OpenBSD's adaptation of the > <a href="http://www.XFree86.org/">XFree86-3</a> software project. > This is here just for historical purposes, most users will have no definitely wrong as is, I changed it a little differently. > Index: goals.html > =================================================================== > RCS file: /cvs/www/goals.html,v > retrieving revision 1.70 > diff -u goals.html > --- goals.html 3 Apr 2008 22:31:06 -0000 1.70 > +++ goals.html 4 Sep 2009 18:01:31 -0000 > @@ -39,12 +39,12 @@ > <a href="products.html">commercial spin-offs</a> of OpenBSD.<p> > <li>Pay attention to <a href="security.html">security problems and fix > them before anyone else does</a>. (Try to be the #1 most > - secure operating system).<p> > + secure operating system.)<p> > <li><a href="crypto.html">Greater integration of cryptographic software.</a> > This means IPsec, key engines, Kerberos, free-AFS, > and other forms of strong crypto or crypto-using systems. > OpenBSD is developed and released from Canada and due to Canadian > - law it is legal to export crypto to the world. (As > + law it is legal to export crypto to the world (as > <a href="http://www.efc.ca/pages/doc/crypto-export.html"> > researched by a Canadian individual</a> and as > <a href="http://axion.physics.ubc.ca/ECL.html"> > Index: plus46.html > =================================================================== > RCS file: /cvs/www/plus46.html,v > retrieving revision 1.1 Janne Johansson took care of that one, I do believe. > Index: query-pr.html > =================================================================== > RCS file: /cvs/www/query-pr.html,v > retrieving revision 1.2 > diff -u query-pr.html > --- query-pr.html 7 Mar 2003 14:58:14 -0000 1.2 > +++ query-pr.html 4 Sep 2009 18:01:53 -0000 > @@ -41,7 +41,7 @@ > To search for PRs based on their contents, fill out the form below. > Multiple selections are <tt>AND</tt>ed together. > You may use regular expressions for all text boxes other than the > -<em>PR numbers(s)</em> field. > +<em>PR number(s)</em> field. > You do not have to fill in everything; fields that are not filled > in will simply be ignored. yep. Thanks! Nick.