annotate scripts/miscellaneous/module.mk @ 26202:368dc1142072

makeValidName.m, makeUniqueStrings.m: Clean up functions to use Octave conventions. * NEWS: Alphabetize list of newly added functions. * var.txi: Add matlab.lang.makeValidName, matlab.lang.makeUniqueStrings to manual. * makeUniqueStrings.m: Use standard copyright block for Octave. Rename input "str" from "x". Rename output "uniqstr" from "y". Rename "converttochar" to "convert2char". Set default for maxlength to Inf (disabling maxlength restriction). Drop periods from end of all error messages. Use variable names from documentation in error messages. Use isindex() to simplify input validation. Delete istruncated variable and re-use ismodified variable. Add FIXME note about calls to ismember being slow. Rename temporary variable 'z' to "tmp". Check that error messages are correct in input validation BIST tests. * makeValidName.m: Use standard copyright block for Octave. Rename input "str" from "x". Rename output "varname" from "y". Rename "converttochar" to "convert2char". Use @table to describe "ReplacementStyle" option. Drop periods from end of all error messages. Use variable names from documentation in error messages. Use strcmp() rather than ismember() for speed. Replace subfunction isvalidname() with built-in isvarname(). Check that error messages are correct in input validation BIST tests. * scripts/legacy/genvarname.m: Move m-file to legacy directory. Add note at top of docstring that this function should not be used in modern code. Add seealso references to makeUniqueStrings and makeValidName. * scripts/legacy/module.mk: Add genvarname.m to legacy directory. * scripts/miscellaneous/module.mk: Remove genvarname.m from miscellaneous dir.
author Rik <rik@octave.org>
date Tue, 11 Dec 2018 13:14:09 -0800
parents 96bc9ee8e77f
children 0f187a956d47
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20343
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
1 FCN_FILE_DIRS += \
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
2 scripts/miscellaneous \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
3 %reldir%/private
9794
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
5 %canon_reldir%_PRIVATE_FCN_FILES = \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
6 %reldir%/private/__publish_html_output__.m \
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
7 %reldir%/private/__publish_latex_output__.m \
23526
dc3745744aef maint: sort lists of function files
Mike Miller <mtmiller@octave.org>
parents: 23495
diff changeset
8 %reldir%/private/__w2mpth__.m \
dc3745744aef maint: sort lists of function files
Mike Miller <mtmiller@octave.org>
parents: 23495
diff changeset
9 %reldir%/private/display_info_file.m
9899
9f25290a35e8 more private function and subfunction changes
John W. Eaton <jwe@octave.org>
parents: 9794
diff changeset
10
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
11 %canon_reldir%_FCN_FILES = \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
12 %reldir%/bug_report.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
13 %reldir%/bunzip2.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
14 %reldir%/cast.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
15 %reldir%/citation.m \
26170
96bc9ee8e77f clearvars.m: Implement new function.
Rik <rik@octave.org>
parents: 25782
diff changeset
16 %reldir%/clearvars.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
17 %reldir%/compare_versions.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
18 %reldir%/computer.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
19 %reldir%/copyfile.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
20 %reldir%/delete.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
21 %reldir%/dir.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
22 %reldir%/dos.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
23 %reldir%/edit.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
24 %reldir%/fact.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
25 %reldir%/fieldnames.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
26 %reldir%/fileattrib.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
27 %reldir%/fileparts.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
28 %reldir%/fullfile.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
29 %reldir%/getfield.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
30 %reldir%/grabcode.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
31 %reldir%/gunzip.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
32 %reldir%/info.m \
24861
7d66084d2660 maint: sort lists of function files in build system
Mike Miller <mtmiller@octave.org>
parents: 24600
diff changeset
33 %reldir%/inputParser.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
34 %reldir%/inputname.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
35 %reldir%/isdeployed.m \
25782
0862570da0ae isfile.m: New function for Matlab compatibility (bug #54508).
Rik <rik@octave.org>
parents: 25781
diff changeset
36 %reldir%/isfile.m \
25780
7c5956c45a29 isfolder.m: New function for Matlab compatibility (bug #54456).
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 25012
diff changeset
37 %reldir%/isfolder.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
38 %reldir%/ismac.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
39 %reldir%/ispc.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
40 %reldir%/isunix.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
41 %reldir%/license.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
42 %reldir%/list_primes.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
43 %reldir%/loadobj.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
44 %reldir%/ls.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
45 %reldir%/ls_command.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
46 %reldir%/menu.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
47 %reldir%/methods.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
48 %reldir%/mex.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
49 %reldir%/mexext.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
50 %reldir%/mkdir.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
51 %reldir%/mkoctfile.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
52 %reldir%/movefile.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
53 %reldir%/namelengthmax.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
54 %reldir%/nargchk.m \
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
55 %reldir%/narginchk.m \
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
56 %reldir%/nargoutchk.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
57 %reldir%/news.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
58 %reldir%/nthargout.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
59 %reldir%/open.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
60 %reldir%/orderfields.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
61 %reldir%/pack.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
62 %reldir%/parseparams.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
63 %reldir%/perl.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
64 %reldir%/publish.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
65 %reldir%/python.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
66 %reldir%/recycle.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
67 %reldir%/run.m \
24491
d8fb16ab0992 maint: move non-numeric m-files from general/ to miscellaneous/ dir.
Rik <rik@octave.org>
parents: 24490
diff changeset
68 %reldir%/saveobj.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
69 %reldir%/setfield.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
70 %reldir%/substruct.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
71 %reldir%/swapbytes.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
72 %reldir%/symvar.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
73 %reldir%/tar.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
74 %reldir%/tempdir.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
75 %reldir%/unix.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
76 %reldir%/unpack.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
77 %reldir%/untar.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
78 %reldir%/unzip.m \
24861
7d66084d2660 maint: sort lists of function files in build system
Mike Miller <mtmiller@octave.org>
parents: 24600
diff changeset
79 %reldir%/validateattributes.m \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
80 %reldir%/ver.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
81 %reldir%/version.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
82 %reldir%/what.m \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
83 %reldir%/zip.m
20343
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
84
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
85 %canon_reldir%dir = $(fcnfiledir)/miscellaneous
20343
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
86
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
87 %canon_reldir%_DATA = $(%canon_reldir%_FCN_FILES)
20343
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
88
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
89 %canon_reldir%_privatedir = $(fcnfiledir)/miscellaneous/private
20343
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
90
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
91 %canon_reldir%_private_DATA = $(%canon_reldir%_PRIVATE_FCN_FILES)
20343
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
92
916cc788d906 fix installation of script files
John W. Eaton <jwe@octave.org>
parents: 20328
diff changeset
93 FCN_FILES += \
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
94 $(%canon_reldir%_FCN_FILES) \
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
95 $(%canon_reldir%_PRIVATE_FCN_FILES)
9794
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents:
diff changeset
96
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
97 PKG_ADD_FILES += %reldir%/PKG_ADD
9906
8d20fb66a0dc more automake fixes
John W. Eaton <jwe@octave.org>
parents: 9899
diff changeset
98
23495
8308417aff1c use automake %reldir% feature
John W. Eaton <jwe@octave.org>
parents: 22160
diff changeset
99 DIRSTAMP_FILES += %reldir%/$(octave_dirstamp)