Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Kevin Ryde]

[-- Attachment #1: Type: text/plain, Size: 1108 bytes --]

For those who came in late, this started on gnu-emacs-sources looking
to get makeinfo-buffer use Info-mode to show its foo.info output, as
opposed to the current raw buffer (which in particular is not good
when using the default file splitting, since foo.info is merely a tags
table in that case.)

Richard Stallman <rms@gnu.org> writes:
>
> This seems to be a combination of changes to existing files
> and new functions.  Could you send diff -c output showing the
> changes to the existing files?

2002-11-29  Kevin Ryde  <user42@zip.com.au>

	* textmodes/makeinfo.el (makeinfo-buffer): Display result using
	Info-mode.
	(makeinfo-compilation-sentinel-buffer, makeinfo-current-node):
	New functions.
	(makeinfo-compile): Add a sentinel parameter.
	(makeinfo-compilation-sentinel-region): Renamed from
	makeinfo-compilation-sentinel, and makeinfo-temp-file now never nil.
	(makeinfo-region): Use this.
	* info.el (Info-revert-find-node): New function.

Reindenting has bloated the makeinfo-compilation-sentinel-region diff,
the only change, as stated, is no need to check for makeinfo-temp-file
being nil.


[-- Attachment #2: info.el.diff --]
[-- Type: text/plain, Size: 1881 bytes --]

*** info.el.~1.324.~	Wed Nov 20 08:24:39 2002
--- info.el	Sat Nov 30 09:09:47 2002
***************
*** 535,540 ****
--- 535,574 ----
    (set (make-local-variable 'Info-current-file) t)
    (Info-find-node-2 nil nodename))
  
+ ;; It's perhaps a bit nasty to kill the *info* buffer to force a re-read,
+ ;; but at least it keeps this routine (which is only for the benefit of
+ ;; makeinfo-buffer) out of the way of normal operations.
+ ;;
+ (defun Info-revert-find-node (filename nodename)
+   "Go to an info node FILENAME and NODENAME, re-reading disk contents.
+ When *info* is already displaying FILENAME and NODENAME, the window position
+ is preserved, if possible."
+   (pop-to-buffer "*info*")
+   (let ((old-filename Info-current-file)
+ 	(old-nodename Info-current-node)
+ 	(pcolumn      (current-column))
+ 	(pline        (count-lines (point-min) (line-beginning-position)))
+ 	(wline        (count-lines (point-min) (window-start)))
+ 	(old-history  Info-history)
+ 	(new-history (and Info-current-file
+ 			  (list Info-current-file Info-current-node (point)))))
+     (kill-buffer (current-buffer))
+     (Info-find-node filename nodename)
+     (setq Info-history old-history)
+     (if (and (equal old-filename Info-current-file)
+ 	     (equal old-nodename Info-current-node))
+ 	(progn
+ 	  ;; note goto-line is no good, we want to measure from point-min
+ 	  (beginning-of-buffer)
+ 	  (forward-line wline)
+ 	  (set-window-start (selected-window) (point))
+ 	  (beginning-of-buffer)
+ 	  (forward-line pline)
+ 	  (move-to-column pcolumn))
+       ;; only add to the history when coming from a different file+node
+       (if new-history
+ 	  (setq Info-history (cons new-history Info-history))))))
+ 
  (defun Info-find-in-tag-table-1 (marker regexp case-fold)
    "Find a node in a tag table.
  MARKER specifies the buffer and position to start searching at.

[-- Attachment #3: makeinfo.el.diff --]
[-- Type: text/plain, Size: 6694 bytes --]

*** makeinfo.el.~1.13.~	Mon Jan 28 09:59:48 2002
--- makeinfo.el	Sat Nov 30 09:14:51 2002
***************
*** 1,6 ****
  ;;; makeinfo.el --- run makeinfo conveniently
  
! ;; Copyright (C) 1991, 1993 Free Software Foundation, Inc.
  
  ;; Author: Robert J. Chassell      
  ;; Maintainer: FSF
--- 1,6 ----
  ;;; makeinfo.el --- run makeinfo conveniently
  
! ;; Copyright (C) 1991, 1993, 2002 Free Software Foundation, Inc.
  
  ;; Author: Robert J. Chassell      
  ;; Maintainer: FSF
***************
*** 47,52 ****
--- 47,53 ----
  ;;; Variables used by `makeinfo'
  
  (require 'compile)
+ (require 'info)
  
  (defgroup makeinfo nil
    "Run makeinfo conveniently"
*************** (defvar makeinfo-temp-file nil
*** 78,83 ****
--- 79,87 ----
  (defvar makeinfo-output-file-name nil
    "Info file name used for text output by `makeinfo'.")
  
+ (defvar makeinfo-output-node-name nil
+   "Node name to visit in output file, for `makeinfo-buffer'.")
+ 
  \f
  ;;; The `makeinfo' function definitions
  
*************** (defun makeinfo-region (region-beginning
*** 167,178 ****
                       " " 
                       makeinfo-temp-file)
               "Use `makeinfo-buffer' to gain use of the `next-error' command"
! 	     nil)))))))
  
  ;;; Actually run makeinfo.  COMMAND is the command to run.
  ;;; ERROR-MESSAGE is what to say when next-error can't find another error.
  ;;; If PARSE-ERRORS is non-nil, do try to parse error messages.
! (defun makeinfo-compile (command error-message parse-errors)
    (let ((buffer
  	 (compile-internal command error-message nil
  			   (and (not parse-errors)
--- 171,183 ----
                       " " 
                       makeinfo-temp-file)
               "Use `makeinfo-buffer' to gain use of the `next-error' command"
! 	     nil
!              'makeinfo-compilation-sentinel-region)))))))
  
  ;;; Actually run makeinfo.  COMMAND is the command to run.
  ;;; ERROR-MESSAGE is what to say when next-error can't find another error.
  ;;; If PARSE-ERRORS is non-nil, do try to parse error messages.
! (defun makeinfo-compile (command error-message parse-errors sentinel)
    (let ((buffer
  	 (compile-internal command error-message nil
  			   (and (not parse-errors)
*************** (defun makeinfo-compile (command error-m
*** 181,207 ****
  				;; ever find any errors.
  				(lambda (&rest ignore)
  				  (setq compilation-error-list nil))))))
!     (set-process-sentinel (get-buffer-process buffer)
! 			  'makeinfo-compilation-sentinel)))
  
  ;; Delete makeinfo-temp-file after processing is finished,
  ;; and visit Info file.
  ;; This function is called when the compilation process changes state.
  ;; Based on `compilation-sentinel' in compile.el
! (defun makeinfo-compilation-sentinel (proc msg)
    (compilation-sentinel proc msg)
!   (if (and makeinfo-temp-file (file-exists-p makeinfo-temp-file))
!       (delete-file makeinfo-temp-file))
!   ;; Always use the version on disk.
!   (let ((buffer (get-file-buffer makeinfo-output-file-name)))
!     (if buffer
! 	(with-current-buffer buffer
! 	  (revert-buffer t t))
!       (setq buffer (find-file-noselect makeinfo-output-file-name)))
!     (if (window-dedicated-p (selected-window))
! 	(switch-to-buffer-other-window buffer)
!       (switch-to-buffer buffer)))
!   (goto-char (point-min)))
  
  (defun makeinfo-buffer ()
    "Make Info file from current buffer.
--- 186,221 ----
  				;; ever find any errors.
  				(lambda (&rest ignore)
  				  (setq compilation-error-list nil))))))
!     (set-process-sentinel (get-buffer-process buffer) sentinel)))
  
  ;; Delete makeinfo-temp-file after processing is finished,
  ;; and visit Info file.
  ;; This function is called when the compilation process changes state.
  ;; Based on `compilation-sentinel' in compile.el
! (defun makeinfo-compilation-sentinel-region (proc msg)
!   "Sentinel for `makeinfo-compile' run from `makeinfo-region'."
    (compilation-sentinel proc msg)
!   (when (memq (process-status proc) '(signal exit))
!     (if (file-exists-p makeinfo-temp-file)
! 	(delete-file makeinfo-temp-file))
!     ;; Always use the version on disk.
!     (let ((buffer (get-file-buffer makeinfo-output-file-name)))
!       (if buffer
! 	  (with-current-buffer buffer
! 	    (revert-buffer t t))
! 	(setq buffer (find-file-noselect makeinfo-output-file-name)))
!       (if (window-dedicated-p (selected-window))
! 	  (switch-to-buffer-other-window buffer)
! 	(switch-to-buffer buffer)))
!     (goto-char (point-min))))
! 
! (defun makeinfo-current-node ()
!   "Return the name of the node containing point, in a texinfo file."
!   (save-excursion
!     (end-of-line)           ; in case point is at the start of an @node line
!     (if (re-search-backward "^@node\\s-+\\([^,\n]+\\)" (point-min) t)
!         (match-string 1)
!       "Top")))
  
  (defun makeinfo-buffer ()
    "Make Info file from current buffer.
*************** (defun makeinfo-buffer ()
*** 225,240 ****
             "^@setfilename[ \t]+\\([^ \t\n]+\\)[ \t]*"
             search-end t)
            (setq makeinfo-output-file-name 
!                 (buffer-substring (match-beginning 1) (match-end 1)))
          (error
           "The texinfo file needs a line saying: @setfilename <name>"))))
    
    (save-excursion
      (makeinfo-compile
       (concat makeinfo-run-command " " makeinfo-options
               " " buffer-file-name)
       "No more errors."
!      t)))
  
  (defun makeinfo-recenter-compilation-buffer (linenum)
    "Redisplay `*compilation*' buffer so most recent output can be seen.
--- 239,265 ----
             "^@setfilename[ \t]+\\([^ \t\n]+\\)[ \t]*"
             search-end t)
            (setq makeinfo-output-file-name 
!                 (expand-file-name
!                  (buffer-substring (match-beginning 1) (match-end 1))))
          (error
           "The texinfo file needs a line saying: @setfilename <name>"))))
+   (setq makeinfo-output-node-name (makeinfo-current-node))
    
    (save-excursion
      (makeinfo-compile
       (concat makeinfo-run-command " " makeinfo-options
               " " buffer-file-name)
       "No more errors."
!      t
!      'makeinfo-compilation-sentinel-buffer)))
! 
! (defun makeinfo-compilation-sentinel-buffer (proc msg)
!   "Sentinel for `makeinfo-compile' run from `makeinfo-buffer'."
!   (compilation-sentinel proc msg)
!   (when (memq (process-status proc) '(signal exit))
!     (when (file-exists-p makeinfo-output-file-name)
!       (Info-revert-find-node
!        makeinfo-output-file-name makeinfo-output-node-name))))
  
  (defun makeinfo-recenter-compilation-buffer (linenum)
    "Redisplay `*compilation*' buffer so most recent output can be seen.

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Thien-Thi Nguyen]

Kevin Ryde <user42@zip.com.au> writes:

   Reindenting has bloated the diff [...]

some diff programs support -w and -b to ignore whitespace changes.
see also ~/.cvsrc for persistent config.

thi

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Eli Zaretskii]

On 30 Nov 2002, Thien-Thi Nguyen wrote:

> Kevin Ryde <user42@zip.com.au> writes:
> 
>    Reindenting has bloated the diff [...]
> 
> some diff programs support -w and -b to ignore whitespace changes.

Yes, but then Patch could choke on such a diff.  So please don't.

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Miles Bader]

Eli Zaretskii <eliz@is.elta.co.il> writes:
> > some diff programs support -w and -b to ignore whitespace changes.
> 
> Yes, but then Patch could choke on such a diff.  So please don't.

It depends on whether the patch is intended for applying or for
explanation.  I think in this case it was just intended to show the
proposed changes.  Perhaps the safest thing is to send both patches --
e.g. the `-wb' patch first for humans to read, and then the real patch
as an attachment or something...

-Miles
-- 
Saa, shall we dance?  (from a dance-class advertisement)

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Eli Zaretskii]

On 2 Dec 2002, Miles Bader wrote:

> Eli Zaretskii <eliz@is.elta.co.il> writes:
> > > some diff programs support -w and -b to ignore whitespace changes.
> > 
> > Yes, but then Patch could choke on such a diff.  So please don't.
> 
> It depends on whether the patch is intended for applying or for
> explanation.

Yes, of course.  But some people try to study the patch by applying it.

> I think in this case it was just intended to show the
> proposed changes.  Perhaps the safest thing is to send both patches --
> e.g. the `-wb' patch first for humans to read, and then the real patch
> as an attachment or something...

That would be nice, but it sounds like excessive requirement.

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Stefan Monnier]

> >    Reindenting has bloated the diff [...]
> > 
> > some diff programs support -w and -b to ignore whitespace changes.
> 
> Yes, but then Patch could choke on such a diff.  So please don't.

I don't know what version of patch you're using, but I haven't
had any such problems with the ones I've used.
The only problem is that re-indenting might be necessary after applying
the patch, so it is admittedly, not the best way to transmit a diff
if the intent is to apply it rather than to look at it,


	Stefan

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Eli Zaretskii]

On Mon, 2 Dec 2002, Stefan Monnier wrote:

> > Yes, but then Patch could choke on such a diff.  So please don't.
> 
> I don't know what version of patch you're using

I'm using Patch 2.5.3.

> I haven't had any such problems with the ones I've used.

Perhaps because you didn't use the whole array of ignore-whitespace 
options that GNU Diff supports.  Try -bBw, and you will surely have hunks 
that Patch will refuse to apply.

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Kevin Ryde]

Miles Bader <miles@lsi.nec.co.jp> writes:
>
> It depends on whether the patch is intended for applying or for
> explanation.

For applying, actually, perhaps after other makeinfo users gave it a
run or whatever.  I'm sorry I even mentioned the indenting now, it
wasn't supposed to be a big deal :-).

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Richard Stallman]

I think it would be nice to write a command in Emacs that would
simplify patches for easier viewing.  It could note lines that just
change in whitespace and remove them.

One way to do this might be to copy the base file, patch in the patch,
then run diff with suitable args to make it look nicer.

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Miles Bader]

Richard Stallman <rms@gnu.org> writes:
> I think it would be nice to write a command in Emacs that would
> simplify patches for easier viewing.  It could note lines that just
> change in whitespace and remove them.

Ediff has some functionality like this -- it `refines' thunks it gets
from diff by doing its own diff algorithm at the character level, and
can indicate via faces which parts of thunks are important.

Perhaps the ediff code that does this can be stolen to provide a simple
filter for patch files that could add face text properties as
appropriate.

-Miles
-- 
We live, as we dream -- alone....

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Eli Zaretskii]

On 4 Dec 2002, Miles Bader wrote:

> Ediff has some functionality like this -- it `refines' thunks it gets
> from diff by doing its own diff algorithm at the character level, and
> can indicate via faces which parts of thunks are important.

IIRC, Ediff does this at the _word_ level, not at the character level.  It 
breaks each line in the hunk into words, then constructs a temporary file 
where each word is on its own line.  It then submits two such temp files 
to `diff' and interprets the results.

That is, given the simple hunk

 ! foo bar baz more stuff
 ---
 ! foo another baz less stuff

Ediff will produce two files like this:

  foo
  bar
  baz
  more
  stuff

and

  foo
  another
  baz
  less
  stuff

and run `diff' on them.  The results will show that the second and the 
fourth word changed, but the rest didn't.

The only problem with this solution is that breaking a line into a list 
of words is non-trivial due to m17n considerations, especially if the 
buffer mixes several character sets.  IIRC, for that reason, Ediff uses 
some ad-hoc method instead of relying on syntax categories of characters.

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Miles Bader]

Eli Zaretskii <eliz@is.elta.co.il> writes:
> > Ediff has some functionality like this -- it `refines' thunks it gets
> > from diff by doing its own diff algorithm at the character level, and
> > can indicate via faces which parts of thunks are important.
> 
> IIRC, Ediff does this at the _word_ level, not at the character level.

A bit of testing shows that you're right.

> The only problem with this solution is that breaking a line into a list 
> of words is non-trivial due to m17n considerations, especially if the 
> buffer mixes several character sets.  IIRC, for that reason, Ediff uses 
> some ad-hoc method instead of relying on syntax categories of characters.

That's OK; for the purpose Richard was asking about, the main thing is
that it ignores (or rather, de-emphasizes) whitespace-only changes,
which should work fine even if word-splitting isn't exactly `correct.'

-Miles
-- 
"I distrust a research person who is always obviously busy on a task."
   --Robert Frosch, VP, GM Research

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Eli Zaretskii]

On 4 Dec 2002, Miles Bader wrote:

> > The only problem with this solution is that breaking a line into a list 
> > of words is non-trivial due to m17n considerations, especially if the 
> > buffer mixes several character sets.  IIRC, for that reason, Ediff uses 
> > some ad-hoc method instead of relying on syntax categories of characters.
> 
> That's OK; for the purpose Richard was asking about, the main thing is
> that it ignores (or rather, de-emphasizes) whitespace-only changes,
> which should work fine even if word-splitting isn't exactly `correct.'

Right.  We are left with the task of defining what is white space (not 
entirely trivial, as we saw in recent discussions here), but that is much 
easier than what Ediff needs to do.

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[David Masterson]

>>>>> Miles Bader writes:

> Richard Stallman <rms@gnu.org> writes:

>> I think it would be nice to write a command in Emacs that would
>> simplify patches for easier viewing.  It could note lines that just
>> change in whitespace and remove them.

> Ediff has some functionality like this -- it `refines' thunks it
> gets from diff by doing its own diff algorithm at the character
> level, and can indicate via faces which parts of thunks are
> important.

> Perhaps the ediff code that does this can be stolen to provide a
> simple filter for patch files that could add face text properties as
> appropriate.

Doesn't the epatch part of ediff already take this into account by
allowing you to patch the file temporarily and then bring up ediff to
allow you to walk through and accept each of the diffs?  Plus, could
you use ediff-diff?-options to tell diff to ignore whitespace
differences (via '-w')?

-- 
David Masterson                David DOT Masterson AT synopsys DOT com
Sr. R&D Engineer               Synopsys, Inc.
Software Engineering           Sunnyvale, CA

Re: makeinfo-info.el - use Info-mode with makeinfo-buffer

[Miles Bader]

On Wed, Dec 04, 2002 at 11:19:35AM -0800, David Masterson wrote:
> > Perhaps the ediff code that does this can be stolen to provide a
> > simple filter for patch files that could add face text properties as
> > appropriate.
> 
> Doesn't the epatch part of ediff already take this into account by
> allowing you to patch the file temporarily and then bring up ediff to
> allow you to walk through and accept each of the diffs?

I certainly don't want to use ediff's interface for this -- it's way too
heavyweight and clunky just to browse an email patch!

-Miles
-- 
P.S.  All information contained in the above letter is false,
      for reasons of military security.