From 3eca9a03816f95da0030665223c0b5262f223ba7 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 16:44:06 +0200 Subject: [PATCH] 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'. --- src/fns.c | 29 ++++++++++++++++++----------- src/lread.c | 1 + 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/src/fns.c b/src/fns.c index 617a8e873da..b21e93d109a 100644 --- a/src/fns.c +++ b/src/fns.c @@ -2808,17 +2808,24 @@ require_unwind (Lisp_Object old_value) DEFUN ("require", Frequire, Srequire, 1, 3, 0, doc: /* If feature FEATURE is not loaded, load it from FILENAME. -If FEATURE is not a member of the list `features', then the feature -is not loaded; so load the file FILENAME. -If FILENAME is omitted, the printname of FEATURE is used as the file name, -and `load' will try to load this name appended with the suffix `.elc', -`.el', or the system-dependent suffix for dynamic module files, in that -order. The name without appended suffix will not be used. -See `get-load-suffixes' for the complete list of suffixes. -If the optional third argument NOERROR is non-nil, -then return nil if the file is not found instead of signaling an error. -Normally the return value is FEATURE. -The normal messages at start and end of loading FILENAME are suppressed. */) +If FEATURE is not a member of the list `features', then the feature is +not loaded; so load the file FILENAME. + +If FILENAME is omitted, the printname of FEATURE is used as the file +name, and `load' will try to load this name appended with the suffix +`.elc', `.el', or the system-dependent suffix for dynamic module +files, in that order. The name without appended suffix will not be +used. See `get-load-suffixes' for the complete list of suffixes. + +The directories in `load-path' are searched when trying to find the +file name. + +If the optional third argument NOERROR is non-nil, then return nil if +the file is not found instead of signaling an error. Normally the +return value is FEATURE. + +The normal messages at start and end of loading FILENAME are +suppressed. */) (Lisp_Object feature, Lisp_Object filename, Lisp_Object noerror) { Lisp_Object tem; diff --git a/src/lread.c b/src/lread.c index 6e97e079650..44507281f2f 100644 --- a/src/lread.c +++ b/src/lread.c @@ -4576,6 +4576,7 @@ were read in. */); doc: /* List of directories to search for files to load. Each element is a string (directory file name) or nil (meaning `default-directory'). +This list is consulted by the `require' function. Initialized during startup as described in Info node `(elisp)Library Search'. Use `directory-file-name' when adding items to this path. However, Lisp programs that process this list should tolerate directories both with -- 2.39.2