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: [RFA/C] Break out C options into a separate file


> X-Original-To: geoffk@foam.wonderslug.com
> Date: Wed, 21 May 2003 09:47:10 +0100 (BST)
> From: "Joseph S. Myers" <jsm28@cam.ac.uk>
> X-X-Sender: jsm28@kern.srcf.societies.cam.ac.uk
> Cc: Neil Booth <neil@daikokuya.co.uk>, gcc-patches@gcc.gnu.org
> X-OriginalArrivalTime: 21 May 2003 08:47:07.0984 (UTC) FILETIME=[8FBF9D00:01C31F75]
> 
> On Wed, 20 May 2003, Geoff Keating wrote:
> 
> > 1. Please please put the '--help' output in the file with the options, if
> >    at all possible.  (In fact, it'd be pretty cool if the documentation could
> >    go there too, because that way adding an extra option would require
> >    changing only one place.)
> 
> It can never require changing only one place - you need to implement what 
> the option is meant to do as well.  All generated Texinfo docs still need 
> to be checked into CVS (e.g. f/intdoc.texi, gnat_ug_*.texi) for use in 
> onlinedocs generation (so that doesn't require configuring and building 
> the compiler).  Where one file contains both documentation for the manual 
> and code for the compiler, it probably also needs GPL/GFDL dual licensing.  
> (And you need appropriate coding to get the options in the right order in 
> the output Texinfo file.)  But it would be good if it were impossible to 
> have an option supported at all without nonempty Texinfo documentation.

Well, if we can't have one place, how about we try for two?  At
present, it's something like five places, and it's very easy to forget
one (usually --help output or Texinfo documentation).

-- 
- Geoffrey Keating <geoffk@geoffk.org>


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