Minor edits of function descriptions, includes, etc.

darcs-hash:20060502162950-ac50b-c2fcfc957d55f292744bcb4b33b4d66fc42087ed.gz

doc_src/doc.hdr

@@ -758,9 +758,10 @@ certain environment variables.
 
 \c fish also sends additional information to the user through the
 values of certain environment variables. The user can not change the
-values of these variables. They are:
+values of most of these variables. 
 
 - \c _, which is the name of the currently running command.
+- \c argv, which is an array of arguments to the shell or function. \c argv is only defined when inside a function call, or if fish was invoked with a list of arguments, like 'fish myscript.fish foo bar'. This variable can be changed by the user.
 - \c history, which is an array containing the last commands that where entered.
 - \c HOME, which is the users home directory. This variable can only be changed by the root user.
 - \c PWD, which is the current working directory. 
@@ -769,11 +770,11 @@ values of these variables. They are:
 - \c LANG, \c LC_ALL, \c LC_COLLATE, \c LC_CTYPE, \c LC_MESSAGES, \c LC_MONETARY, \c LC_NUMERIC and \c LC_TIME set the language option for the shell and subprograms. See the section <a href='#variables-locale'>Locale variables</a> for more information.
 
 Variables whose name are in uppercase are exported to the commands
-started by fish. This rule is not enforced by fish, but it is good
-coding practice to use casing to distinguish between exported and
-unexported variables. \c fish also uses several variables
-internally. Such variables are prefixed with the string __FISH or
-__fish. These should be ignored by the user.
+started by fish, those in lowercase are not exported. This rule is not
+enforced by fish, but it is good coding practice to use casing to
+distinguish between exported and unexported variables. \c fish also
+uses several variables internally. Such variables are prefixed with
+the string __FISH or __fish. These should be ignored by the user.
 
 \subsection variables-locale Locale variables
 

fallback.h

@@ -213,7 +213,8 @@ wchar_t *wcsndup( const wchar_t *in, int c );
 
 /**
    Converts from wide char to digit in the specified base. If d is not
-   a valid digit in the specified base, return -1.
+   a valid digit in the specified base, return -1. This is a helper
+   function for wcstol, but it is useful itself, so it is exported.
 */
 long convert_digit( wchar_t d, int base );
 

key_reader.c

@@ -5,6 +5,8 @@
 
 	Type ^C to exit the program.
 */
+#include "config.h"
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>

proc.h

@@ -328,7 +328,8 @@ void proc_update_jiffies();
 void proc_sanity_check();
 
 /**
-   Send of an process/job exit event notification. This function is a conveniance wrapper around event_fire().
+   Send a process/job exit event notification. This function is a
+   conveniance wrapper around event_fire().
 */
 void proc_fire_event( const wchar_t *msg, int type, pid_t pid, int status );