Mercurial > octave

annotate scripts/prefs/prefdir.m @ 30564:796f54d4ddbf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.
author John W. Eaton <jwe@octave.org>
date Tue, 28 Dec 2021 18:22:40 -0500
parents 0a5b15007766
children 5d3faba0342e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
3 ## Copyright (C) 2013-2022 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
7 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
8 ## This file is part of Octave.
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22549
diff changeset
13 ## (at your option) any later version.
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
14 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22549
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22549
diff changeset
18 ## GNU General Public License for more details.
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
19 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
25
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20834
diff changeset
27 ## @deftypefn {} {} prefdir
21906
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
28 ## @deftypefnx {} {} prefdir (1)
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20834
diff changeset
29 ## @deftypefnx {} {@var{dir} =} prefdir
20834
27b333c88c8e Overhaul m-files in prefs directory.
Rik <rik@octave.org>
parents: 20017
diff changeset
30 ## Return the directory that holds the preferences for Octave.
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
31 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
32 ## Examples:
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
33 ##
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
34 ## Display the preferences directory
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17020
diff changeset
35 ##
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
36 ## @example
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
37 ## prefdir
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
38 ## @end example
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
39 ##
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
40 ## Change to the preferences folder
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17020
diff changeset
41 ##
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
42 ## @example
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
43 ## cd (prefdir)
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
44 ## @end example
21906
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
45 ##
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
46 ## If called with an argument, the preferences directory is created if it
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
47 ## doesn't already exist.
17020
960ac70ac8f3 prefdir.m: Adjust seealso references in docstring.
Rik <rik@octave.org>
parents: 17017
diff changeset
48 ## @seealso{getpref, setpref, addpref, rmpref, ispref}
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
49 ## @end deftypefn
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
50
20834
27b333c88c8e Overhaul m-files in prefs directory.
Rik <rik@octave.org>
parents: 20017
diff changeset
51 function dir = prefdir ()
17010
c50ee84842a9 Add preferences and prefdir functions
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
52
20834
27b333c88c8e Overhaul m-files in prefs directory.
Rik <rik@octave.org>
parents: 20017
diff changeset
53 dir = get_home_directory ();
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
54
21906
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
55 if (nargin > 0)
25787
3293cd2651fb prefer 'isfolder' over 'exist (..., "dir")' in Octave functions
Mike Miller <mtmiller@octave.org>
parents: 25054
diff changeset
56 if (! isfolder (dir))
21906
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
57 mkdir (dir);
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
58 endif
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
59 endif
e0952881e051 prefdir: Turn into a public function, make Matlab compatible (bug #48221)
Mike Miller <mtmiller@octave.org>
parents: 20852
diff changeset
60
17017
8003a4f013be Announce new prefdir, preferences functions and add to manual.
Rik <rik@octave.org>
parents: 17010
diff changeset
61 endfunction