autoconf-patches
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: more documentation proofreading


From: Akim Demaille
Subject: Re: more documentation proofreading
Date: 10 Apr 2001 11:15:06 +0200
User-agent: Gnus/5.0808 (Gnus v5.8.8) XEmacs/21.1 (Cuyahoga Valley)

Hi Steven,

I have a few more detailed comments on your patch, and question a few
question of English :)  I learned a lot from your patch, but there are
still a few things I don't understand well.


|  You are now able to understand one of the constructs of Autoconf that
| -has continuously been misunderstood...  The rule of thumb is that
| +has been continually misunderstood...  The rule of thumb is that

What is the difference between the two?  Continuously is mathematical?
Or continuously is `spatial' and continually related to time?


| address@hidden b10;}.  There was a idiom developed in the Autoconf world to
| address@hidden b10;}.  (There was a idiom common in Autoconf's past to

s/a idiom/an idiom/ I guess.


| address@hidden (not to be confounded with the quote characters).  You may
| +as @ovar{arg} (not to be confused with the quote characters).  You may

What is the difference?

  confound
       2: mistake one thing for another; "you are confusing me with
          the other candidate"; "I mistook her for the secretary"
          [syn: {mistake}, {confuse}]


| @@ -800,6 +802,8 @@
|  # Process this file with autoconf to produce a configure script.
|  @end example
|  
| +Such comments will be included in the generated @file{configure} script.
| +

I would not include this.  For instance, it does not apply to any
comment before AC_INIT, which is precisely what the example above is
about.  Rule for # comments are not straight to describe.


| -If you want to disable @command{autoconf}'s defaults and @code{WARNING}
| +If you want to disable @command{autoconf}'s defaults and @code{WARNING},

s/WARNING/&S/


|  @noindent
| -The long @var{separator}s can be used to ease parsing of complex
| +A long @var{separator} can be used to improve the readability of complex

Here I was really referring to mechanical reading, so I don't know if
`readability' really applies.


| @@ -2052,6 +2057,9 @@
|  @end group
|  @end example
|  
| +(Be careful if you copy these lines directly into your Makefile, as you
| +will need to convert the indented lines to start with the tab character.)
| +

There should be a @noindent right before this paragraph.


| -For instance:
| +For example:

What is the difference?


| +One can then run:
|  @example
|  ./config.status host.h object.h
|  @end example
| -to establish the links.
| +to create the links.
|  @end defmac

A @noindent is missing after @end example.


| @@ -8025,10 +8036,10 @@
|  beginning of a line, followed by a comment that repeats the name of the
|  macro being defined.  If you want to avoid the new-line which is then
|  introduced, use @code{dnl}.  Better yet, use @samp{[]dnl} @emph{even}
| -behind of parenthesis, since because of the M4 evaluation rule the
| +inside of parentheses: because of the M4 evaluation rules, the

Hm, actually I meant `after the closing paren', not inside.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]