This is the mail archive of the gcc@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]

Re: Missing documentation


>>>>> "Zack" == Zack Weinberg <zackw@stanford.edu> writes:

    >>  -print-multi-lib -print-multi-directory

    Zack> I believe these are only used for arcane purposes during the
    Zack> build of GCC itself.  That doesn't mean they shouldn't be
    Zack> documented, but perhaps invoke.texi is not the best place.

I agree -- but our current policy is to document all options in
invoke.texi.  We all agree that we eventually want to separate the
manual into user documentation and maintainer documentation, and some
of these options should probably move at that point.  (And, in fact,
when build for production use the options should maybe just not be
present in the compiler at all.)

So, for now, if you're willing to add information to invoke.texi about
any of the options you mentioned, that would be great.

    >> -fpreprocessed

    Zack> This is for internal use, mostly; the driver passes it to
    Zack> cc1 when it's fed an .i file.  It'll be mentioned in
    Zack> cpp.texi after I check in the rewrite (today, I hope).
    Zack> Should it also appear in invoke.texi?

Yes, please -- but you can make it just be a cross-reference if you
want, like:

  Users should not have to use this option; it is for internal use
  only.  For more information, see <link to cpp.texi>.

Thanks!

--
Mark Mitchell                   mark@codesourcery.com
CodeSourcery, LLC               http://www.codesourcery.com


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