Grep Searching node in building.texi

Grep Searching node in building.texi

[Juri Linkov]

I checked the node `Grep Searching' and want to propose the following
corrections.  I think mentioning the `-nH' option is essential
(and also I find the phrase `where there were' too clumsy).

Index: man/building.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/man/building.texi,v
retrieving revision 1.65
diff -c -r1.65 building.texi
*** man/building.texi	23 Jun 2005 01:22:28 -0000	1.65
--- man/building.texi	4 Aug 2005 02:12:08 -0000
***************
*** 325,337 ****
  
  @findex grep
    Just as you can run a compiler from Emacs and then visit the lines
! where there were compilation errors, you can also run @code{grep} and
  then visit the lines on which matches were found.  This works by
  treating the matches reported by @code{grep} as if they were ``errors.''
  
    To do this, type @kbd{M-x grep}, then enter a command line that
  specifies how to run @code{grep}.  Use the same arguments you would give
! @code{grep} when running it normally: a @code{grep}-style regexp
  (usually in single-quotes to quote the shell's special characters)
  followed by file names, which may use wildcards.  If you specify a
  prefix argument for @kbd{M-x grep}, it figures out the tag
--- 325,340 ----
  
  @findex grep
    Just as you can run a compiler from Emacs and then visit the lines
! with compilation errors, you can also run @code{grep} and
  then visit the lines on which matches were found.  This works by
  treating the matches reported by @code{grep} as if they were ``errors.''
  
    To do this, type @kbd{M-x grep}, then enter a command line that
  specifies how to run @code{grep}.  Use the same arguments you would give
! @code{grep} when running it normally: the @samp{-nH} options to
! print the filename and the line number (without these options you
! will not be able to visit matches in the source file from
! the @code{grep} output buffer) and a @code{grep}-style regexp
  (usually in single-quotes to quote the shell's special characters)
  followed by file names, which may use wildcards.  If you specify a
  prefix argument for @kbd{M-x grep}, it figures out the tag

-- 
Juri Linkov
http://www.jurta.org/emacs/

Re: Grep Searching node in building.texi

[Juri Linkov]

> I checked the node `Grep Searching' and want to propose the following
> corrections.  I think mentioning the `-nH' option is essential
> (and also I find the phrase `where there were' too clumsy).

Grep commands are described in the node `Grep Searching' but their
headings currently are located in the node `Compilation'.
This diverges from the documentation standard where nodes start with
headings containing a command name and short description, and the rest
of the node provides more complete description.

Even though grep-mode is based on compilation-mode, this fact is
already mentioned in the beginning of `Grep Searching', and any
mention of grep in the node `Compilation' is irrelevant.

Index: man/building.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/man/building.texi,v
retrieving revision 1.66
diff -c -r1.66 building.texi
*** man/building.texi	9 Aug 2005 21:48:12 -0000	1.66
--- man/building.texi	10 Aug 2005 00:32:32 -0000
***************
*** 48,63 ****
  @item M-x recompile
  Invoke a compiler with the same command as in the last invocation of
  @kbd{M-x compile}.
- @item M-x grep
- Run @code{grep} asynchronously under Emacs, with matching lines
- listed in the buffer named @samp{*grep*}.
- @item M-x grep-find
- @itemx M-x find-grep
- Run @code{grep} via @code{find}, with user-specified arguments, and
- collect output in the buffer named @samp{*grep*}.
  @item M-x kill-compilation
! @itemx M-x kill-grep
! Kill the running compilation or @code{grep} subprocess.
  @end table
  
  @findex compile
--- 48,55 ----
  @item M-x recompile
  Invoke a compiler with the same command as in the last invocation of
  @kbd{M-x compile}.
  @item M-x kill-compilation
! Kill the running compilation subprocess.
  @end table
  
  @findex compile
***************
*** 323,335 ****
  @node Grep Searching
  @section Searching with Grep under Emacs
  
- @findex grep
    Just as you can run a compiler from Emacs and then visit the lines
  with compilation errors, you can also run @code{grep} and
  then visit the lines on which matches were found.  This works by
  treating the matches reported by @code{grep} as if they were ``errors.''
  
!   To do this, type @kbd{M-x grep}, then enter a command line that
  specifies how to run @code{grep}.  Use the same arguments you would give
  @code{grep} when running it normally: a @code{grep}-style regexp
  (usually in single-quotes to quote the shell's special characters)
--- 315,339 ----
  @node Grep Searching
  @section Searching with Grep under Emacs
  
    Just as you can run a compiler from Emacs and then visit the lines
  with compilation errors, you can also run @code{grep} and
  then visit the lines on which matches were found.  This works by
  treating the matches reported by @code{grep} as if they were ``errors.''
  
! @table @kbd
! @item M-x grep
! Run @code{grep} asynchronously under Emacs, with matching lines
! listed in the buffer named @samp{*grep*}.
! @item M-x grep-find
! @itemx M-x find-grep
! Run @code{grep} via @code{find}, with user-specified arguments, and
! collect output in the buffer named @samp{*grep*}.
! @item M-x kill-grep
! Kill the running @code{grep} subprocess.
! @end table
! 
! @findex grep
!   To run @code{grep}, type @kbd{M-x grep}, then enter a command line that
  specifies how to run @code{grep}.  Use the same arguments you would give
  @code{grep} when running it normally: a @code{grep}-style regexp
  (usually in single-quotes to quote the shell's special characters)

-- 
Juri Linkov
http://www.jurta.org/emacs/