public inbox for gcc@gcc.gnu.org
 help / color / mirror / Atom feed
From: Geoffrey Keating <geoffk@geoffk.org>
To: "Joseph S. Myers" <joseph@codesourcery.com>
Cc: Geoffrey Keating <gkeating@apple.com>, gcc@gcc.gnu.org
Subject: move specs documentation to internals manual?
Date: Fri, 08 Jul 2005 23:29:00 -0000	[thread overview]
Message-ID: <m21x68khaq.fsf_-_@geoffk.org> (raw)
In-Reply-To: <Pine.LNX.4.61.0507081217260.14395@digraph.polyomino.org.uk>

"Joseph S. Myers" <joseph@codesourcery.com> writes:

> On Fri, 7 Jul 2005, Ian Lance Taylor wrote:
> 
> > gkeating@apple.com (Geoffrey Keating) writes:
> > 
> > > 	* gcc.c: Include xregex.h.
> > > 	(version_compare_spec_function): New.
> > > 	(spec_function): Add version-compare.
> > > 	(replace_outfile_spec_function): Reformat comment.
> > > 	(compare_version_strings): New.
> > 
> > I think version-compare should be documented in the specs file section
> > of invoke.texi.
> 
> I think having this documentation in invoke.texi is a mistake - specs are 
> internals rather than something for users to use.  The documentation 
> should either be in the internals manual or be in comments in gcc.c, not 
> both and not the user manual.

I agree with both comments here: it's lame that we have duplicated
documentation (and explains why I didn't realise that I had to change
two places), and I don't think that we should be considering specs to
be an user-level interface to GCC.

So, what do people think about (a) deleting the big comment in gcc.c
that tries to explain specs (leaving a pointer to the manual), and (b)
moving the specs documentation to the internals manual?

       reply	other threads:[~2005-07-08 23:29 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20050708054604.67D4A15D66FE@geoffk5.apple.com>
     [not found] ` <m3vf3lvld8.fsf@gossamer.airs.com>
     [not found]   ` <Pine.LNX.4.61.0507081217260.14395@digraph.polyomino.org.uk>
2005-07-08 23:29     ` Geoffrey Keating [this message]
2005-07-09  0:23       ` Daniel Jacobowitz
2005-07-09  0:32         ` Joseph S. Myers
2005-07-09  0:32       ` Joel Sherrill <joel@OARcorp.com>

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m21x68khaq.fsf_-_@geoffk.org \
    --to=geoffk@geoffk.org \
    --cc=gcc@gcc.gnu.org \
    --cc=gkeating@apple.com \
    --cc=joseph@codesourcery.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).