annotate lisp/cus-file.el @ 5104:868a5349acee

add documentation to frame.c, rearrange some functions to consolidate in related areas -------------------- ChangeLog entries follow: -------------------- src/ChangeLog addition: 2010-03-05 Ben Wing <ben@xemacs.org> * frame.c: * frame.c (frame_live_p): * frame.c (Fframep): * frame.c (Fdisable_frame): * frame.c (Fenable_frame): * frame.c (Fraise_frame): * frame.c (Fframe_name): * frame.c (Fset_frame_height): * frame.c (internal_set_frame_size): * frame.c (adjust_frame_size): Add documentation on the different types of units used to measure frame size. Add section headers to the various sections. Rearrange the location of some functions in the file to keep related functions together. This especially goes for frame-sizing functions (internal_set_frame_size() and adjust_frame_size()), which have been moved so that they form a group with change_frame_size() and change_frame_size_1(). No functionality should change.
author Ben Wing <ben@xemacs.org>
date Fri, 05 Mar 2010 22:50:27 -0600
parents abe6d1db359e
children 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
1 ;;; cus-file.el --- Manage location of the customize init file
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
2
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
3 ;; Copyright (C) 2000 by Free Software Foundation, Inc.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
4
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
5 ;; Author: Mike Sperber <mike@xemacs.org>
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
6 ;; Keywords: internal
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
7
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
8 ;; This file is part of XEmacs.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
9
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
10 ;; XEmacs is free software; you can redistribute it and/or modify it
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
11 ;; under the terms of the GNU General Public License as published by
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
13 ;; any later version.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
14
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
15 ;; XEmacs is distributed in the hope that it will be useful, but
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
18 ;; General Public License for more details.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
19
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
23 ;; 02111-1307, USA.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
24
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
25 ;;; Synched up with: Not in FSF
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
26
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
27 ;;; Commentary:
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
28
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
29 ;; This file manages the location of the custom init file without
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
30 ;; loading all of the custom code itself.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
31
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
32
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
33 ;;; Code:
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
34 (provide 'cus-file)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
35
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
36 ;;;###autoload
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
37 (defconst custom-file-base "custom.el"
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
38 "Base of file name for storing customization information.")
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
39
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
40 ;;;###autoload
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
41 (defvar custom-file nil
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
42 "File used for storing customization information.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
43 If you change this from the default you need to
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
44 explicitly load that file for the settings to take effect.")
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
45
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
46 ;;;###autoload
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
47 (defun make-custom-file-name (init-file &optional force-new)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
48 "Construct the default custom file name from the init file name.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
49 If FORCE-NEW is non-nil, force post-migration location."
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
50 (let ((init-file (or init-file user-init-file)))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
51 (if (or force-new
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
52 (not init-file)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
53 (string= (file-name-directory init-file)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
54 (expand-file-name
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
55 (file-name-as-directory user-init-directory))))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
56 (expand-file-name custom-file-base user-init-directory)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
57 init-file)))
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
58
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents:
diff changeset
59 ;;; cus-file.el ends here