Bug 178700

Summary: [patch] adds a tip about a missing index file
Product: Documentation Reporter: Drahos Cagan <drahos_1>
Component: Books & ArticlesAssignee: Warren Block <wblock>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
patch-ports.diff none

Description Drahos Cagan 2013-05-17 03:00:01 UTC 
The patch adds a tip to the ports chapter, what to do before running 'make search' command, if the index file is missing.

Fix: Apply the attached patch.

Patch attached with submission follows:
How-To-Repeat: 1. Install fresh ports or delete INDEX from /usr/ports.
2. Run 'make search name=port-name'.
Comment 1 Eitan Adler freebsd_committer freebsd_triage 2013-05-17 03:00:01 UTC 
Responsible Changed
From-To: freebsd-doc->eadler

I'll take it
Comment 2 Eitan Adler freebsd_committer freebsd_triage 2013-05-18 05:35:53 UTC 
On 16 May 2013 21:49, Drahos Cagan <drahos_1@yahoo.com> wrote:

...

Two issues

a) replacable is not a valid tag: I think you meant 'replaceable'
b) generally, diffs from the root are preferred so we know which file
is changing ('chapter.xml' is not very descriptive)

would you like to change the patch or shall I fix it?


-- 
Eitan Adler
Comment 3 Warren Block freebsd_committer freebsd_triage 2013-05-18 12:36:26 UTC 
Responsible Changed
From-To: eadler->wblock

Take.
Comment 4 dfilter service freebsd_committer freebsd_triage 2013-05-23 11:30:06 UTC 
Author: wblock
Date: Thu May 23 10:29:53 2013
New Revision: 41717
URL: http://svnweb.freebsd.org/changeset/doc/41717

Log:
  Add tip about downloading the INDEX file if it is not present.
  
  PR:		docs/178700
  Submitted by:	Drahos Cagan <drahos_1@yahoo.com>

Modified:
  head/en_US.ISO8859-1/books/handbook/ports/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/ports/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/ports/chapter.xml	Thu May 23 09:55:34 2013	(r41716)
+++ head/en_US.ISO8859-1/books/handbook/ports/chapter.xml	Thu May 23 10:29:53 2013	(r41717)
@@ -292,6 +292,16 @@ Index:  sysutils
 B-deps:
 R-deps: </screen>
 
+	<tip>
+	  <para><command>make search</command> searches through a file
+	    of index information.  If a message indicates the
+	    <filename>INDEX</filename> is required, run
+	    <command>make fetchindex</command> to download the current
+	    index file.  With the <filename>INDEX</filename> present,
+	    <command>make search</command> will be able to perform the
+	    requested search.</para>
+	</tip>
+
 	<para>The <quote>Path:</quote> line indicates where to find
 	  the port.</para>
 
_______________________________________________
svn-doc-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"
Comment 5 Warren Block freebsd_committer freebsd_triage 2013-05-23 11:30:21 UTC 
State Changed
From-To: open->closed

Patch committed, thanks!