diff options
| author | Lars Ingebrigtsen | 2016-04-30 16:44:06 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2016-05-01 19:27:12 +0200 |
| commit | 137868051e5ce4c4ba9cc92caa26fbf968e6f208 (patch) | |
| tree | 9bb251311c5a5c68eaa867088989098c64143fee /src | |
| parent | a73de71b848da17719dcbbb9206302c09e0f79b9 (diff) | |
| download | emacs-137868051e5ce4c4ba9cc92caa26fbf968e6f208.tar.gz emacs-137868051e5ce4c4ba9cc92caa26fbf968e6f208.zip | |
Have the doc strings of `load-path' and `require' mention each other
* src/fns.c (Frequire): Mention `load-path' and fill the doc
string (bug#18829).
* src/lread.c (syms_of_lread): Mention that `require' uses
`load-path'.
(cherry picked from commit 3eca9a03816f95da0030665223c0b5262f223ba7)
Diffstat (limited to 'src')
| -rw-r--r-- | src/fns.c | 29 | ||||
| -rw-r--r-- | src/lread.c | 1 |
2 files changed, 19 insertions, 11 deletions
| @@ -2762,17 +2762,24 @@ require_unwind (Lisp_Object old_value) | |||
| 2762 | 2762 | ||
| 2763 | DEFUN ("require", Frequire, Srequire, 1, 3, 0, | 2763 | DEFUN ("require", Frequire, Srequire, 1, 3, 0, |
| 2764 | doc: /* If feature FEATURE is not loaded, load it from FILENAME. | 2764 | doc: /* If feature FEATURE is not loaded, load it from FILENAME. |
| 2765 | If FEATURE is not a member of the list `features', then the feature | 2765 | If FEATURE is not a member of the list `features', then the feature is |
| 2766 | is not loaded; so load the file FILENAME. | 2766 | not loaded; so load the file FILENAME. |
| 2767 | If FILENAME is omitted, the printname of FEATURE is used as the file name, | 2767 | |
| 2768 | and `load' will try to load this name appended with the suffix `.elc', | 2768 | If FILENAME is omitted, the printname of FEATURE is used as the file |
| 2769 | `.el', or the system-dependent suffix for dynamic module files, in that | 2769 | name, and `load' will try to load this name appended with the suffix |
| 2770 | order. The name without appended suffix will not be used. | 2770 | `.elc', `.el', or the system-dependent suffix for dynamic module |
| 2771 | See `get-load-suffixes' for the complete list of suffixes. | 2771 | files, in that order. The name without appended suffix will not be |
| 2772 | If the optional third argument NOERROR is non-nil, | 2772 | used. See `get-load-suffixes' for the complete list of suffixes. |
| 2773 | then return nil if the file is not found instead of signaling an error. | 2773 | |
| 2774 | Normally the return value is FEATURE. | 2774 | The directories in `load-path' are searched when trying to find the |
| 2775 | The normal messages at start and end of loading FILENAME are suppressed. */) | 2775 | file name. |
| 2776 | |||
| 2777 | If the optional third argument NOERROR is non-nil, then return nil if | ||
| 2778 | the file is not found instead of signaling an error. Normally the | ||
| 2779 | return value is FEATURE. | ||
| 2780 | |||
| 2781 | The normal messages at start and end of loading FILENAME are | ||
| 2782 | suppressed. */) | ||
| 2776 | (Lisp_Object feature, Lisp_Object filename, Lisp_Object noerror) | 2783 | (Lisp_Object feature, Lisp_Object filename, Lisp_Object noerror) |
| 2777 | { | 2784 | { |
| 2778 | Lisp_Object tem; | 2785 | Lisp_Object tem; |
diff --git a/src/lread.c b/src/lread.c index d374406e7b9..ef58b20070d 100644 --- a/src/lread.c +++ b/src/lread.c | |||
| @@ -4508,6 +4508,7 @@ were read in. */); | |||
| 4508 | doc: /* List of directories to search for files to load. | 4508 | doc: /* List of directories to search for files to load. |
| 4509 | Each element is a string (directory file name) or nil (meaning | 4509 | Each element is a string (directory file name) or nil (meaning |
| 4510 | `default-directory'). | 4510 | `default-directory'). |
| 4511 | This list is consulted by the `require' function. | ||
| 4511 | Initialized during startup as described in Info node `(elisp)Library Search'. | 4512 | Initialized during startup as described in Info node `(elisp)Library Search'. |
| 4512 | Use `directory-file-name' when adding items to this path. However, Lisp | 4513 | Use `directory-file-name' when adding items to this path. However, Lisp |
| 4513 | programs that process this list should tolerate directories both with | 4514 | programs that process this list should tolerate directories both with |