unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: James Muchow <jim_muchow@dell.com>
To: "Francesco Potortì" <pot@gnu.org>, "Eli Zaretskii" <eliz@gnu.org>
Cc: "22306@debbugs.gnu.org" <22306@debbugs.gnu.org>
Subject: bug#22306: 24.5; Unhide --no-line-directive Documentation
Date: Mon, 11 Jan 2016 16:11:45 +0000	[thread overview]
Message-ID: <8543a3ac28a841169e403b2bd50610c7@mspexmb1.Beer.Town> (raw)
In-Reply-To: <E1aI2uN-0003we-Cv@tucano.isti.cnr.it>

> From: Francesco Potortì [mailto:pot@gnu.org] 
> Sent: Saturday, January 09, 2016 5:27 PM
>>> From: James Muchow <jim_muchow@dell.com>
>>> Date: Mon, 4 Jan 2016 19:41:28 +0000
>>> 
>>> In trying to create a TAGS file, etags would process the
>>> #line directive in various source files and produce TAGS 
>>> files that were unusable because the "file name" included
>>> would be unavailable causing the tags-search to exit before
>>> having seen all files.
>>> 
>>> I spent a lot of time coming up with a solution to avoid
>>> any files that contained a line directive when the solution
>>> I really needed was already present: --no-line-directive.
>>> It is, however, undocumented and thus the only way to know
>>> about it is to download the source. I downloaded the source
>>> to try and find out what etags was doing wrong with #line
>>> when I discovered this undocumented option.
>>> 
>>> I see from the source that the --no-line-directive is hidden
>>> by the PRINT_UNDOCUMENTED_OPTIONS_HELP; I think it would be
>>> helpful for others to remove this restriction.
>>
>> Francesco,
>> 
>> Are there any reasons to keep this option (and a few others) hidden
>> from the user eyes?
>
> For this specific otion, the logs say that I undocumented it in 2002.
> As far as I can recall, this was because the option seemed too much
> technical to me, that is of little use and difficult to explain.  I
> think I adopted the same criterion for undocumenting the other options.

First of all thanks for cleaning up my request and getting rid of
all the extraneous verbiage. I've never filed a bug report before,
so I didn't quite know what to expect. Anyway...

I am aware that the documentation hiding was done years ago. As to
whether it is too technical or not; the fact is that in our
environment, the TAGS files I produced are useless (30M of 
useless) and that was quickly diagnosed to those files that use 
the #line directive.

Resolving this issue involved, as I wrote, a lot of time when the
solution was already present the whole time. A solution of which
I was unaware because it was deemed too technical.

I now know of this option, so I could take the "I don't care, I
got mine" approach, but I thought that such a trivial fix might
be turn out to be helpful to someone else. But YMMV, I'll leave
the eventual resolution in your hands.






  reply	other threads:[~2016-01-11 16:11 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-04 19:41 bug#22306: 24.5; Unhide --no-line-directive Documentation James Muchow
2016-01-09 19:51 ` Eli Zaretskii
2016-01-09 23:26   ` Francesco Potortì
2016-01-11 16:11     ` James Muchow [this message]
2016-01-15  8:58     ` Eli Zaretskii

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=8543a3ac28a841169e403b2bd50610c7@mspexmb1.Beer.Town \
    --to=jim_muchow@dell.com \
    --cc=22306@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=pot@gnu.org \
    /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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

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).