aboutsummaryrefslogtreecommitdiffstats
path: root/src/print.c
diff options
context:
space:
mode:
authorGerd Moellmann2001-03-20 13:31:03 +0000
committerGerd Moellmann2001-03-20 13:31:03 +0000
commit5845f63eec591fe5ff6536e1f1e5fe6ded0d6a6f (patch)
tree25f5912aa21cfcf48952030599e1e8f793b1456e /src/print.c
parent6e92282b89dcb3ce1234574fc371eeee1e594898 (diff)
downloademacs-5845f63eec591fe5ff6536e1f1e5fe6ded0d6a6f.tar.gz
emacs-5845f63eec591fe5ff6536e1f1e5fe6ded0d6a6f.zip
(syms_of_print): Doc fixes.
Diffstat (limited to 'src/print.c')
-rw-r--r--src/print.c30
1 files changed, 17 insertions, 13 deletions
diff --git a/src/print.c b/src/print.c
index e9dd4ede83f..c55fe18a403 100644
--- a/src/print.c
+++ b/src/print.c
@@ -1,5 +1,5 @@
1/* Lisp object printing and output streams. 1/* Lisp object printing and output streams.
2 Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 98, 1999, 2000 2 Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 98, 1999, 2000, 2001
3 Free Software Foundation, Inc. 3 Free Software Foundation, Inc.
4 4
5This file is part of GNU Emacs. 5This file is part of GNU Emacs.
@@ -1957,8 +1957,8 @@ A value of nil means no limit.");
1957 Vprint_level = Qnil; 1957 Vprint_level = Qnil;
1958 1958
1959 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines, 1959 DEFVAR_BOOL ("print-escape-newlines", &print_escape_newlines,
1960 "Non-nil means print newlines in strings as backslash-n.\n\ 1960 "Non-nil means print newlines in strings as `\\n'.\n\
1961Also print formfeeds as backslash-f."); 1961Also print formfeeds as `\\f'.");
1962 print_escape_newlines = 0; 1962 print_escape_newlines = 0;
1963 1963
1964 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii, 1964 DEFVAR_BOOL ("print-escape-nonascii", &print_escape_nonascii,
@@ -1969,20 +1969,20 @@ Only single-byte characters are affected, and only in `prin1'.");
1969 1969
1970 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte, 1970 DEFVAR_BOOL ("print-escape-multibyte", &print_escape_multibyte,
1971 "Non-nil means print multibyte characters in strings as \\xXXXX.\n\ 1971 "Non-nil means print multibyte characters in strings as \\xXXXX.\n\
1972\(XXX is the hex representation of the character code.)\n\ 1972\(XXXX is the hex representation of the character code.)\n\
1973This affects only `prin1'."); 1973This affects only `prin1'.");
1974 print_escape_multibyte = 0; 1974 print_escape_multibyte = 0;
1975 1975
1976 DEFVAR_BOOL ("print-quoted", &print_quoted, 1976 DEFVAR_BOOL ("print-quoted", &print_quoted,
1977 "Non-nil means print quoted forms with reader syntax.\n\ 1977 "Non-nil means print quoted forms with reader syntax.\n\
1978I.e., (quote foo) prints as 'foo, (function foo) as #'foo, and, backquoted\n\ 1978I.e., (quote foo) prints as 'foo, (function foo) as #'foo, and backquoted\n\
1979forms print in the new syntax."); 1979forms print as in the new syntax.");
1980 print_quoted = 0; 1980 print_quoted = 0;
1981 1981
1982 DEFVAR_LISP ("print-gensym", &Vprint_gensym, 1982 DEFVAR_LISP ("print-gensym", &Vprint_gensym,
1983 "Non-nil means print uninterned symbols so they will read as uninterned.\n\ 1983 "Non-nil means print uninterned symbols so they will read as uninterned.\n\
1984I.e., the value of (make-symbol \"foobar\") prints as #:foobar.\n\ 1984I.e., the value of (make-symbol \"foobar\") prints as #:foobar.\n\
1985When the uninterned symbol appears within a recursive data structure\n\ 1985When the uninterned symbol appears within a recursive data structure,\n\
1986and the symbol appears more than once, in addition use the #N# and #N=\n\ 1986and the symbol appears more than once, in addition use the #N# and #N=\n\
1987constructs as needed, so that multiple references to the same symbol are\n\ 1987constructs as needed, so that multiple references to the same symbol are\n\
1988shared once again when the text is read back."); 1988shared once again when the text is read back.");
@@ -2001,15 +2001,19 @@ where N is a positive decimal integer.");
2001 Vprint_circle = Qnil; 2001 Vprint_circle = Qnil;
2002 2002
2003 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering, 2003 DEFVAR_LISP ("print-continuous-numbering", &Vprint_continuous_numbering,
2004 "*Non-nil means keep numbering between several print functions.\n\ 2004 "*Non-nil means number continuously across print calls.\n\
2005See `print-gensym' nad `print-circle'. See also `print-number-table'."); 2005This affects the numbers printed for #N= labels and #M# references.\n\
2006See also `print-circle', `print-gensym', and `print-number-table'.\n\
2007This variable should not be set with `setq'; bind it with a `let' instead.");
2006 Vprint_continuous_numbering = Qnil; 2008 Vprint_continuous_numbering = Qnil;
2007 2009
2008 DEFVAR_LISP ("print-number-table", &Vprint_number_table, 2010 DEFVAR_LISP ("print-number-table", &Vprint_number_table,
2009 "A vector keeping the information of the current printed object.\n\ 2011 "A vector used internally to produce `#N=' labels and `#N#' references.\n\
2010This variable shouldn't be modified in Lisp level, but should be binded\n\ 2012The Lisp printer uses this vector to detect Lisp objects referenced more\n\
2011with nil using let at the same position with `print-continuous-numbering',\n\ 2013than once. When `print-continuous-numbering' is bound to t, you should\n\
2012so that the value of this variable can be freed after printing."); 2014probably also bind `print-number-table' to nil. This ensures that the\n\
2015value of `print-number-table' can be garbage-collected once the printing\n\
2016is done.");
2013 Vprint_number_table = Qnil; 2017 Vprint_number_table = Qnil;
2014 2018
2015 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */ 2019 /* prin1_to_string_buffer initialized in init_buffer_once in buffer.c */