GNU bug report logs - #28830
[PATCH] gnu: Add emacs-ggtags.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 28830 in the body.
You can then email your comments to 28830 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Oleg Pykhalov <go.wigust <at> gmail.com>
To: guix-patches <at> gnu.org
Subject: [PATCH] gnu: Add emacs-ggtags.
Date: Sat, 14 Oct 2017 12:04:09 +0300

[0001-gnu-Add-emacs-ggtags.patch (text/x-patch, inline)]

From bcd267046dc0ab8e87356519d3e3c60a96f7d5a4 Mon Sep 17 00:00:00 2001
From: Oleg Pykhalov <go.wigust <at> gmail.com>
Date: Sat, 14 Oct 2017 12:03:23 +0300
Subject: [PATCH] gnu: Add emacs-ggtags.

* gnu/packages/emacs.scm (emacs-ggtags): New variable.
---
 gnu/packages/emacs.scm | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/gnu/packages/emacs.scm b/gnu/packages/emacs.scm
index 66f0a2ebe..62338e998 100644
--- a/gnu/packages/emacs.scm
+++ b/gnu/packages/emacs.scm
@@ -1206,6 +1206,51 @@ Using emacs-direnv means that programs started from Emacs will use the
 environment set through Direnv.")
     (license license:gpl3+)))
 
+(define-public emacs-ggtags
+  (package
+    (name "emacs-ggtags")
+    (version "0.8.12")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append "http://elpa.gnu.org/packages/ggtags-"
+                           version ".el"))
+       (sha256
+        (base32
+         "0ny3llk021g6r0s75xdm4hzpbxv393ddm2r6f2xdk8kqnq4gnirp"))))
+    (build-system emacs-build-system)
+    (home-page "https://github.com/leoliu/ggtags")
+    (synopsis "Frontend to GNU Global source code tagging system")
+    (description "@code{ggtags} provides a frontend to GNU Global source code
+tagging system.
+
+Features:
+
+@itemize
+@item Build on @code{compile.el} for asynchronicity and its large feature-set.
+@item Automatically update Global's tag files when needed with tuning for
+large source trees.
+@item Intuitive navigation among multiple matches with mode-line display of
+current match, total matches and exit status.
+@item Read tag with completion.
+@item Show definition at point.
+@item Jump to #include files.
+@item Support search history and saving a search to register/bookmark.
+@item Query replace.
+@item Manage Global's environment variables on a per-project basis.
+@item Highlight (definition) tag at point.
+@item Abbreviated display of file names.
+@item Support all Global search backends: @code{grep}, @code{idutils}, etc.
+@item Support exuberant ctags @url{http://ctags.sourceforge.net/} and
+@code{pygments} backend.
+@item Support all Global's output formats: @code{grep}, @code{ctags-x},
+@code{cscope} etc.
+@item Support projects on remote hosts (e.g. via @code{tramp}).
+@item Support eldoc.
+@item Search @code{GTAGSLIBPATH} for references and symbols.
+@end itemize\n")
+    (license license:gpl3+)))
+
 (define-public emacs-go-mode
   (package
     (name "emacs-go-mode")
-- 
2.14.2

Message #8 received at 28830 <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: Oleg Pykhalov <go.wigust <at> gmail.com>
Cc: 28830 <at> debbugs.gnu.org
Subject: Re: [bug#28830] [PATCH] gnu: Add emacs-ggtags.
Date: Mon, 16 Oct 2017 06:51:31 +0100

[Message part 1 (text/plain, inline)]

On Sat, 14 Oct 2017 12:04:09 +0300
Oleg Pykhalov <go.wigust <at> gmail.com> wrote:

> From bcd267046dc0ab8e87356519d3e3c60a96f7d5a4 Mon Sep 17 00:00:00 2001
> From: Oleg Pykhalov <go.wigust <at> gmail.com>
> Date: Sat, 14 Oct 2017 12:03:23 +0300
> Subject: [PATCH] gnu: Add emacs-ggtags.
> 
> * gnu/packages/emacs.scm (emacs-ggtags): New variable.
> ---
>  gnu/packages/emacs.scm | 45 +++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 45 insertions(+)
> 
> diff --git a/gnu/packages/emacs.scm b/gnu/packages/emacs.scm
> index 66f0a2ebe..62338e998 100644
> --- a/gnu/packages/emacs.scm
> +++ b/gnu/packages/emacs.scm
> @@ -1206,6 +1206,51 @@ Using emacs-direnv means that programs started from Emacs will use the
>  environment set through Direnv.")
>      (license license:gpl3+)))
>  
> +(define-public emacs-ggtags
> +  (package
> +    (name "emacs-ggtags")
> +    (version "0.8.12")
> +    (source
> +     (origin
> +       (method url-fetch)
> +       (uri (string-append "http://elpa.gnu.org/packages/ggtags-"
> +                           version ".el"))
> +       (sha256
> +        (base32
> +         "0ny3llk021g6r0s75xdm4hzpbxv393ddm2r6f2xdk8kqnq4gnirp"))))
> +    (build-system emacs-build-system)
> +    (home-page "https://github.com/leoliu/ggtags")
> +    (synopsis "Frontend to GNU Global source code tagging system")

I'd suggest putting "the" in here, so "Frontend to the GNU Global ...",
as I think that reads better.

> +    (description "@code{ggtags} provides a frontend to GNU Global source code
> +tagging system.
> +
> +Features:
> +
> +@itemize
> +@item Build on @code{compile.el} for asynchronicity and its large feature-set.
> +@item Automatically update Global's tag files when needed with tuning for
> +large source trees.
> +@item Intuitive navigation among multiple matches with mode-line display of
> +current match, total matches and exit status.
> +@item Read tag with completion.
> +@item Show definition at point.
> +@item Jump to #include files.
> +@item Support search history and saving a search to register/bookmark.
> +@item Query replace.
> +@item Manage Global's environment variables on a per-project basis.
> +@item Highlight (definition) tag at point.
> +@item Abbreviated display of file names.
> +@item Support all Global search backends: @code{grep}, @code{idutils}, etc.
> +@item Support exuberant ctags @url{http://ctags.sourceforge.net/} and
> +@code{pygments} backend.
> +@item Support all Global's output formats: @code{grep}, @code{ctags-x},
> +@code{cscope} etc.
> +@item Support projects on remote hosts (e.g. via @code{tramp}).
> +@item Support eldoc.
> +@item Search @code{GTAGSLIBPATH} for references and symbols.
> +@end itemize\n")
> +    (license license:gpl3+)))
> +
>  (define-public emacs-go-mode
>    (package
>      (name "emacs-go-mode")

Similarly with "the GNU Global" in the description. What do you think?
Apart from that, this looks fine to me :)

[Message part 2 (application/pgp-signature, inline)]

Message #11 received at 28830 <at> debbugs.gnu.org (full text, mbox):

From: Oleg Pykhalov <go.wigust <at> gmail.com>
To: Christopher Baines <mail <at> cbaines.net>
Cc: 28830 <at> debbugs.gnu.org
Subject: Re: [bug#28830] [PATCH] gnu: Add emacs-ggtags.
Date: Mon, 16 Oct 2017 13:22:23 +0300

Hello Christopher,

Christopher Baines <mail <at> cbaines.net> writes:

[...]

>> +    (synopsis "Frontend to GNU Global source code tagging system")
>
> I'd suggest putting "the" in here, so "Frontend to the GNU Global ...",
> as I think that reads better.

[...]

> Similarly with "the GNU Global" in the description. What do you think?
> Apart from that, this looks fine to me :)

I don't think so.  Upstream¹ doesn't have an article “the” before GNU
Global, too.  WDYT?

¹ http://elpa.gnu.org/packages/ggtags.html

Message #14 received at 28830 <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: Oleg Pykhalov <go.wigust <at> gmail.com>
Cc: 28830 <at> debbugs.gnu.org
Subject: Re: [bug#28830] [PATCH] gnu: Add emacs-ggtags.
Date: Tue, 31 Oct 2017 08:22:18 +0000

[Message part 1 (text/plain, inline)]

On Mon, 16 Oct 2017 13:22:23 +0300
Oleg Pykhalov <go.wigust <at> gmail.com> wrote:

> Hello Christopher,
> 
> Christopher Baines <mail <at> cbaines.net> writes:
> 
> [...]
> 
> >> +    (synopsis "Frontend to GNU Global source code tagging system")  
> >
> > I'd suggest putting "the" in here, so "Frontend to the GNU Global ...",
> > as I think that reads better.  
> 
> [...]
> 
> > Similarly with "the GNU Global" in the description. What do you think?
> > Apart from that, this looks fine to me :)  
> 
> I don't think so.  Upstream¹ doesn't have an article “the” before GNU
> Global, too.  WDYT?
> 
> ¹ http://elpa.gnu.org/packages/ggtags.html

I don't think there is any harm in improving on the descriptions of the
software from the upstream source. But I'll leave it up to you to make
the decision.

Unfortunately, I don't have a very formal understanding of English
grammar, but there is some information about definite articles [1].
Which I think says that its appropriate to use as there is one,
specific "GNU Global source code tagging system".

1: https://learnenglish.britishcouncil.org/en/english-grammar/determiners-and-quantifiers/definite-article

[Message part 2 (application/pgp-signature, inline)]

Message #17 received at 28830 <at> debbugs.gnu.org (full text, mbox):

From: Oleg Pykhalov <go.wigust <at> gmail.com>
To: Christopher Baines <mail <at> cbaines.net>
Cc: 28830 <at> debbugs.gnu.org, 28830-done <at> debbugs.gnu.org
Subject: Re: [bug#28830] [PATCH] gnu: Add emacs-ggtags.
Date: Tue, 31 Oct 2017 20:11:14 +0300

[Message part 1 (text/plain, inline)]

Hello Christopher,

Christopher Baines <mail <at> cbaines.net> writes:

>> >> +    (synopsis "Frontend to GNU Global source code tagging system")  
>> >
>> > I'd suggest putting "the" in here, so "Frontend to the GNU Global ...",
>> > as I think that reads better.  
>> 
>> [...]
>> 
>> > Similarly with "the GNU Global" in the description. What do you think?
>> > Apart from that, this looks fine to me :)  
>> 
>> I don't think so.  Upstream¹ doesn't have an article “the” before GNU
>> Global, too.  WDYT?
>> 
>> ¹ http://elpa.gnu.org/packages/ggtags.html
>
> I don't think there is any harm in improving on the descriptions of the
> software from the upstream source. But I'll leave it up to you to make
> the decision.
>
> Unfortunately, I don't have a very formal understanding of English
> grammar, but there is some information about definite articles [1].
> Which I think says that its appropriate to use as there is one,
> specific "GNU Global source code tagging system".
>
> 1:
> https://learnenglish.britishcouncil.org/en/english-grammar/determiners-and-quantifiers/definite-article

OK if you fill it's more readable or elegant.

I also checked some installed packages on my system.  It seems common to
use *the* before software name at least in package synopsis.

    Accessing passwords from *the* GNOME keyring  
    Access *the* Debbugs bug tracker in Emacs  
    Adjust *the* color temperature of your screen  
    An implementation of *the* Domain Name System  
    BASH completion for *the* shell buffer  
    Client and server for *the* secure shell (ssh) protocol  
    Commands to start *the* X Window server  
    Copy directory to *the* gh-pages branch  
    Development manual pages from *the* Linux project  
    Discover key bindings for *the* current Emacs major mode  
    Emacs interface for *the* Git version control system  
    Free replacements for *the* PostScript fonts  
    Go to *the* last change in *the* Emacs buffer  
    Grabs *the* path to JSON values in a JSON file  
    Implementation of *the* Perl programming language  
    Lisp dialect running on *the* JVM  
    Locate files on *the* file system  
    Manage encryption keys and passwords in *the* GNOME keyring  
    Polish up poor writing on *the* fly  
    Recursively list *the* contents of a directory  
    Reddit backend for *the* Gnus newsreader  
    Reference manual for *the* C programming language  
    Set *the* keyboard using *the* X Keyboard Extension  
    Single-player, RPG roguelike game set in *the* world of Eyal  
    Suggest Elisp functions that give *the* output requested  
    Terminal emulator for *the* 
    TeX Live, a package of *the* TeX typesetting system  
    *The* extensible, customizable, self-documenting text editor  
    *The* Glasgow Haskell Compiler  
    *The* GNU debugger  
    *The* GNU documentation format  
    *The* OCaml programming language  
    *The* SQLite database management system  
    *The* standard Windows interoperability suite of programs for GNU and Unix  
    Translations from *the* command line  
    Utilities for *the* Advanced Linux Sound Architecture (ALSA)  
    Xorg implementation of *the* X Window System

Pushed as cd5c3979d18ca5bc5d32b9044330453c244df1a5

Thanks,
Oleg.

[signature.asc (application/pgp-signature, inline)]

Message #25 received at 28830 <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: mail <at> cbaines.net, go.wigust <at> gmail.com
Cc: 28830 <at> debbugs.gnu.org
Subject: Re: [bug#28830] [PATCH] gnu: Add emacs-ggtags.
Date: Tue, 31 Oct 2017 20:39:54 +0100

[Message part 1 (text/plain, inline)]

Hullo,

Oleg Pykhalov wrote:
> Pushed as cd5c3979d18ca5bc5d32b9044330453c244df1a5

Thanks (+ congratulations :-)!

Christopher Baines wrote:
> I don't think there is any harm in improving on the descriptions of the
> software from the upstream source.

Agreed. I'd go further & suggest that in cases like this, where there's
an obvious mistake upstream, we be proactive and fix it. Inelegance is
subjective; this isn't.[0]

Kind regards,

T G-R

---

[0]: it would have been correct to write ‘Frontend to <GNU Global>’.
Adding ‘the’ to it would be wrong, since ‘GNU Global’ is a proper noun.

But writing ‘Frontend to <the> GNU Global tagging <system>’ changes the
structure: the object of ‘to’ is now the word ‘system’ and not ‘GNU
Global’. ‘System‘ isn't a proper noun, so it requires an article.

[signature.asc (application/pgp-signature, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.