This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH,ADA,DOC] PR 15479: Fix the Ada manuals


On Wed, 13 Feb 2008, Ralf Wildenhues wrote:
> Ping <http://gcc.gnu.org/ml/gcc-patches/2008-02/msg00058.html>.

I had hoped the Ada maintainers would look into this directly, but 
let me give it a try then.

(It would have been easier for reviewers to attach patches as plain
text, not gzipped since they are small and that also works nicer with
the mail archive.)

>> 	* gnat_rm.texi, gnat_ugn.texi: Bump copyright year.

We have instructions from the FSF not to use ranges for copyright years.
I understand that these predate your patch, but when making changes like
this we should not extend those ranges but add concrete years.  See most
of the GCC source files for examples.

>> 0002-gnat_rm.texi-gnat_ugn.texi-Fix-typos.patch.gz

This is fine for head and all open release branches (as far as 
applicable).  The same holds for all other typo and formatting
patches.

>> 0003-gnat_rm.texi-Aggregates-with-static-bounds-Fix.patch.gz

Unless I grossly misunderstand Ada, this is fine.

>> 0020-gnat_ugn.texi-Regular-Expressions-in-gnatfind-and.patch.gz

Okay.

>> 0019-gnat_ugn.texi-Replace-code-GDB-with-command-gd.patch.gz

Not completely sure about this since, for example, it is @command{gcc}
but the project is called GCC.

>> 0018-gnat_ugn.texi-Using-gnatmake-in-a-Makefile-Do-n.patch.gz

That really one of those where I would have preferred the Ada maintainers
to review, but it looks okay.

>> 0017-gnat_ugn.texi-Examples-of-gnatxref-Usage-Use-c.patch.gz

Okay.  (The patch file title didn't exactly match the patch which
uses @command instead of @file.)

>> 0016-gnat_ugn.texi-In-non-code-avoid-space-before-col.patch.gz

Okay.

>> 0015-gnat_ugn.texi-Character-Set-Control-Do-not-use.patch.gz

Okay.

>> 0013-gnat_ugn.texi-Validity-Checking-Fix-typo-NaNs.patch.gz

Okay.

>> 0008-gnat_rm.texi-gnat_ugn.texi-Where-appropriate-re.patch.gz

Okay, except for the foolowing two where I wonder whether we shouldn't
just use a full stop:

  Note that if you specify at least one file in this part, @code{gnatfind} may
 -sometimes not be able to find the body of the subprograms...
 +sometimes not be able to find the body of the subprograms@enddots{}

  store it in a variable. For small projects, it is often easier to
  specify each of them by hand, since you then have full control over what
  is the proper order for these directories, which ones should be
 -included...
 +included @enddots{}

>> 0006-gnat_rm.texi-gnat_ugn.texi-Where-appropriate-ad.patch.gz

Not sure about

  -@var{Variables}.
  +@code{Variables}.

please omit this for the time being, and a bit below that I believe
we miss @command{...} around gnatmake in one case.

"@command{gcc} manual" actually should be "GCC manual" and ideally a
reference.

-If @var{name} or @var{value} includes a space, then @var{name=value} should be
+If @code{name} or @code{value} includes a space, then @code{name=value} should be

This one doesn't look right!

-that case just by doing a @samp{gnatmake main}, so that GNAT generates
+that case just by doing a @code{gnatmake main}, so that GNAT generates

This doesn't seem right either.

-the command @var{help} invoked from within @code{GDB} activates a simple help
+the command @code{help} invoked from within @code{GDB} activates a simple help

Not sure about this either.  Just GDB and @command or at least @samp 
instead of @code?

-@code{-k} to @code{gnatdll} when creating the import library.
+@option{-k} to @code{gnatdll} when creating the import library.

Shouldn't this be @command{gnatdll}?


Overall also the last patch above is an improvement, but I believe we
need to be careful not to become overeager. ;-)  My recommendation is
to submit any remaining (or resubmitted) patches one at a time which
should make reviewing and generally keeping track (also for you) a bit
simpler.

Thanks for the good work!

Gerald


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]