GNU bug report logs - #3921
23.1.50; checkdoc allow uncapitalized info node links

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 3921 in the body.
You can then email your comments to 3921 AT debbugs.gnu.org in the normal way.

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

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: emacs-pretest-bug <at> gnu.org
Subject: 23.1.50; checkdoc allow uncapitalized info node links
Date: Sat, 25 Jul 2009 09:00:00 +1000

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

M-x checkdoc on the file foo.el below complains

    Name emacs should appear capitalized as Emacs (C-h,f,e,n,p,q)

at the `(emacs)' info link.  I hoped it would recognise that has to be
left as-is, since it must follow the target document's name and nodes.

Perhaps the following, dragging in help-mode.el for a definitive regexp,
and using thingatpt.el just because it's a convenient way to match
surrounding point.

2009-07-25  Kevin Ryde  <user42 <at> zip.com.au>

	* emacs-lisp/checkdoc.el (checkdoc-proper-noun-region-engine): Allow
	uncapitalized in info node hyperlinks.

[foo.el (application/emacs-lisp, attachment)]

[checkdoc.el.info-link.diff (text/x-diff, attachment)]

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

In GNU Emacs 23.1.50.4 (i586-pc-linux-gnu, GTK+ Version 2.16.4)
 of 2009-07-24 on blah.blah
configured using `configure  'CFLAGS=-O -g' '--prefix=/down/emacs/b/inst' '--with-x-toolkit=gtk''

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_AU
  value of $XMODIFIERS: nil
  locale-coding-system: iso-latin-1-unix
  default-enable-multibyte-characters: t

Message #10 received at 3921-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 3921-done <at> debbugs.gnu.org
Subject: Re: 23.1.50; checkdoc allow uncapitalized info node links
Date: Fri, 23 Oct 2009 13:27:58 -0400

> M-x checkdoc on the file foo.el below complains
>
>     Name emacs should appear capitalized as Emacs (C-h,f,e,n,p,q)
>
> at the `(emacs)' info link.  I hoped it would recognise that has to be
> left as-is, since it must follow the target document's name and nodes.
>
> Perhaps the following, dragging in help-mode.el for a definitive regexp,
> and using thingatpt.el just because it's a convenient way to match
> surrounding point.

I checked in a slightly different fix.  Thanks for the bug report.

Message #15 received at 3921 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: 3921 <at> debbugs.gnu.org, control <at> debbugs.gnu.org
Cc: Chong Yidong <cyd <at> stupidchicken.com>
Subject: Re: 23.1.50; checkdoc allow uncapitalized info node links
Date: Sun, 25 Oct 2009 10:38:26 +1100

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

reopen 3921
thanks

Chong Yidong <cyd <at> stupidchicken.com> writes:
>
> I checked in a slightly different fix.

Reopening as I believe the looking-back limit prevents line-wrapped
links working, like the foo.el below.

But why not help-xref-info-regexp?  Less code, no duplication of
patterns.  For a lisp tool there's no need to hold back on what
libraries are loaded -- in fact letting someone else do the work is a
very good thing! :-)

(The worst duplication I struck lately was a while ago in info.el when
digging around some node names.  I recall unlovely duplication of
patterns, making life hard if looking to tighten or loosen.)


I thought of the URL links only afterwards, and didn't do anything about
it.  help-xref-url-regexp would again seem good as an authoritative
pattern.

[checkdoc.el.info-link-2.diff (text/x-diff, inline)]

--- checkdoc.el.~1.78.~	2009-10-25 08:57:10.000000000 +1100
+++ checkdoc.el	2009-10-25 10:05:53.000000000 +1100
@@ -173,6 +173,9 @@
 (defvar checkdoc-version "0.6.1"
   "Release version of checkdoc you are currently running.")
 
+(require 'help-mode) ;; for help-xref-info-regexp
+(require 'thingatpt) ;; for handy thing-at-point-looking-at
+
 (defvar compilation-error-regexp-alist)
 (defvar compilation-mode-font-lock-keywords)
 
@@ -2017,11 +2020,11 @@
 			 (not (and (= ?/ (char-after e))
 				   (= ?/ (char-before b))))
 			 (not (checkdoc-in-example-string-p begin end))
-			 ;; info node
-			 (not (save-excursion
-				(goto-char b)
-				(looking-back "\\<[Ii]nfo[ \t\n]+\\(node\\|anchor\\)[ \t\n]+`("
-					      (line-beginning-position)))))
+			 ;; info or url links left alone
+ 			 (not (thing-at-point-looking-at
+ 			       help-xref-info-regexp))
+			 (not (thing-at-point-looking-at
+ 			       help-xref-url-regexp)))
 		    (if (checkdoc-autofix-ask-replace
 			 b e (format "Text %s should be capitalized.  Fix? "
 				     text)

[foo.el (application/emacs-lisp, attachment)]

Message #22 received at 3921 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 3921 <at> debbugs.gnu.org, control <at> debbugs.gnu.org,
        Chong Yidong <cyd <at> stupidchicken.com>
Subject: Re: bug#3921: 23.1.50; checkdoc allow uncapitalized info node links
Date: Sat, 24 Oct 2009 21:02:12 -0400

> @@ -2017,11 +2020,11 @@
>  			 (not (and (= ?/ (char-after e))
>  				   (= ?/ (char-before b))))
>  			 (not (checkdoc-in-example-string-p begin end))
> -			 ;; info node
> -			 (not (save-excursion
> -				(goto-char b)
> -				(looking-back "\\<[Ii]nfo[ \t\n]+\\(node\\|anchor\\)[ \t\n]+`("
> -					      (line-beginning-position)))))
> +			 ;; info or url links left alone
> + 			 (not (thing-at-point-looking-at
> + 			       help-xref-info-regexp))
> +			 (not (thing-at-point-looking-at
> + 			       help-xref-url-regexp)))
>  		    (if (checkdoc-autofix-ask-replace
>  			 b e (format "Text %s should be capitalized.  Fix? "
>  				     text)

Looks good,


        Stefan

Message #27 received at 3921-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: 3921-done <at> debbugs.gnu.org
Cc: Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#3921: 23.1.50; checkdoc allow uncapitalized info node links
Date: Wed, 28 Oct 2009 10:01:48 +1100

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:
>
> Looks good,

I checked it in.

(And leaving the /emacs/ bit alone, though it may be redundant with the
url-link regexp, as long as everyone uses URL `...' format.)

Previous Next

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