--- Library/Mail Downloads/Updating_Docs_How-to.html 2006-10-05 09:40:11.000000000 -0400 +++ Documents/GRASS/Updating_Docs_How-to.html 2006-10-05 09:29:26.000000000 -0400 @@ -7,14 +7,14 @@

  • To begin, you must obtain the latest Grass source code from the CVS repositories. Detailed instructions on how to do so can be found here. -
  • Once you have downloaded the CVS source code, open a terminal and change directory to where the source for a specific GRASS module is located - in this example, something like: i
    /your_cvs_directory/grass6/vector/v.in.ascii
    . You have to make your edits/corrections to the original copy of the module's description.html page within grass6/vector/v.in.ascii, not a copy of this page. -
  • Open a text editor and make your edits to description.html. Save your edits by overwriting the original description.html. -
  • Within a terminal, create a 'unified diff' (a standard way to show changes between two versions of a file) of the Grass CVS repository version of description.html and your newly edited description.html: +
  • Once you have downloaded the CVS source code, open a terminal and change directory to /your_cvs_directory/grass6/vector/v.in.ascii. You have to make your edits/corrections to the original copy of the module's description.html page within grass6/vector/v.in.ascii, not a copy of this page. +
  • Open a text editor and make your edits to description.html. Depending on where your cvs source is on disk, you may have to do so as root (Ex: sudo gedit description.html). Save your edits by overwriting the original description.html. +
  • Within a terminal, create a 'unified diff' of the Grass CVS repository version of description.html and your newly edited description.html:
     cvs diff -u description.html > description.html.patch
     

    -This "diff" command will create a report in description.html.patch which shows any differences between the version of description.html still on the CVS server and your edited version, with a '+' at the beginning of each altered/new line. The output of the diff -u should look something like this (the exact contents will of course depend on whatever changes you made to the file): +The diff command will show any edits between the cvs description.html and your edited version with a '+' at the beginning of each line in description.html.patch. The output of the diff-u should look something like this:

     Index: description.html
     ===================================================================
    @@ -43,8 +43,6 @@
     The coordinates are listed following the initial line containing the
      primitive code, the total number of vectors in the series, and the number
     
    -(The above line is the end of the example diff file) -
  • Email a Grass developer your description.html.patch for review as an attachment, along with a brief explanation why it is required. Please post a general message about your documentation update to the Grass Developer's Mailing List before sending your patch to anyone in particular.