unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stephen Leake <stephen_leake@stephe-leake.org>
Cc: emacs-devel@gnu.org
Subject: Re: change pcomplete/make to include targets in included files
Date: Sat, 14 Sep 2019 13:08:27 +0300	[thread overview]
Message-ID: <837e6byyuc.fsf@gnu.org> (raw)
In-Reply-To: <86muf7p5w7.fsf@stephe-leake.org> (message from Stephen Leake on Sat, 14 Sep 2019 02:46:16 -0700)

> From: Stephen Leake <stephen_leake@stephe-leake.org>
> Date: Sat, 14 Sep 2019 02:46:16 -0700
> 
> The patch below changes pcomplete/make to include targets in included
> files. The new user option pcmpl-gnu-makefile-includes allows disabling
> this.

I have a couple of minor comments below, and I hope Stefan and others
will provide more substantial ones, if they have them.

> +*** By default, `pcomplete/make' now includes targets in included
> +files, recursively.  To recover the previous behavior, set new user
> +option `pcmpl-gnu-makefile-includes' to nil.

It is best to have the first line of a NEWS entry a complete sentence,
and leave the details for the body.  (Think of a user who reads NEWS
in Outline mode).  In this case, I'd rephrase the first sentence like
this:

  'pcomplete/make' now completes on targets in included files, recursively.

That this is the default is clear from the rest of the text.

Also note that nowadays we prefer to quote 'like this' in NEWS and
other plain-text documentation, not `like this'.

Finally, if you think this feature is worth mentioning in the manual,
please add a patch for the manual and mark the NEWS entry with "+++";
and if you think this feature is too obscure to be in the manual,
please mark the NEWS entry with "---".

> +(defcustom pcmpl-gnu-makefile-includes t
> +  "If non-nil, `pcomplete/make' includes targets in included files."

I find the "includes" part here confusing.  Don't you want to say that
completion candidates will include such targets?

> +(defun pcmpl-gnu-make-targets ()
> +  "Return a list of make targets in the current buffer."

I'd say "makefile targets" here.  If nothing else, it avoids a
sentence with confusing ambiguity ("make" is also a word that has
other meanings).

> +(defun pcmpl-gnu-make-includes ()
> +  "Return a list of all 'include' file names in the current buffer."

Why do we need to quote 'include' here?

> +(defun pcmpl-gnu-make-all-targets (makefile)
> +  "Return a list of target names in MAKEFILE and all included files."

  "Return the list of target names in MAKEFILE and in all files it includes."

Thanks.



  reply	other threads:[~2019-09-14 10:08 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-14  9:46 change pcomplete/make to include targets in included files Stephen Leake
2019-09-14 10:08 ` Eli Zaretskii [this message]
2019-09-14 10:57   ` Eli Zaretskii
2019-09-14 22:04     ` Stephen Leake
2019-09-14 22:03   ` Stephen Leake
2019-09-15  1:43 ` Stefan Monnier
2019-09-15 19:50   ` Stephen Leake
2019-09-15 20:56     ` Stefan Monnier
2019-09-16 23:33       ` Stephen Leake

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=837e6byyuc.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=stephen_leake@stephe-leake.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).