svn commit: r39981 - head/en_US.ISO8859-1/books/faq

[Eitan Adler]

On 12 November 2012 14:58, Benjamin Kaduk <kaduk at mit.edu> wrote:
> On Sun, 11 Nov 2012, Eitan Adler wrote:
>
>> Author: eadler
>> Date: Sun Nov 11 22:29:01 2012
>> New Revision: 39981
>> URL: http://svnweb.freebsd.org/changeset/doc/39981
>>
>> Log:
>>  Reduce redundant markup and word and other minor problems reported by
>>  igor.  Limited additional checking was done of the surrounding content.
>>
>>  Approved by:   jkois (mentor, before merge conflict resolution)
>>
>> Modified:
>>  head/en_US.ISO8859-1/books/faq/book.xml
>>
>> Modified: head/en_US.ISO8859-1/books/faq/book.xml
>>
>> ==============================================================================
>> --- head/en_US.ISO8859-1/books/faq/book.xml     Sun Nov 11 21:42:32 2012
>> (r39980)
>> +++ head/en_US.ISO8859-1/books/faq/book.xml     Sun Nov 11 22:29:01 2012
>> (r39981)
>> @@ -923,7 +923,7 @@
>>                   <para>Where the format is
>>                     <literal>html-split</literal>, the files are bundled
>>                     up using &man.tar.1;.  The resulting
>> -                   <filename>.tar</filename> file is then compressed
>> +                   <filename>.tar</filename> is then compressed
>
>
> This would seem like a candidate where the "redundant" use of "file"
> actually is helpful, since there is not a specific file name given.

Perhaps.   I'll send a patch to bcr & jkois.


>> -           the <command>close lcp</command> command (a following
>> -           <command>term</command> command) will reconnect you to the
>> +           <command>close lcp</command> (a following
>> +           <command>term</command>) will reconnect you to the
>
>
> I have trouble making sense of this sentence; perhaps the close paren is
> misplaced?  Not a bug in your change, but I would have expected it to be
> noticed in pre-commit review.

Note the commit message: ""Limited additional checking was done of the
surrounding content.""
I noticed quite a few things, but few of which I felt I wanted to fix
in this iteration.


>>           <warning>
>> -           <para>The <option>-R</option> option does a
>> +           <para><option>-R</option> does a
>
>
> My understanding was that we did not like to start sentences with markup.

I did not know this.  Can you propose some alternative wording?


-- 
Eitan Adler
Source, Ports, Doc committer
Bugmeister, Ports Security teams