annotate scripts/miscellaneous/perl.m @ 27918:b442ec6dda5c

use centralized file for copyright info for individual contributors * COPYRIGHT.md: New file. * In most other files, use "Copyright (C) YYYY-YYYY The Octave Project Developers" instead of tracking individual names in separate source files. The motivation is to reduce the effort required to update the notices each year. Until now, the Octave source files contained copyright notices that list individual contributors. I adopted these file-scope copyright notices because that is what everyone was doing 30 years ago in the days before distributed version control systems. But now, with many contributors and modern version control systems, having these file-scope copyright notices causes trouble when we update copyright years or refactor code. Over time, the file-scope copyright notices may become outdated as new contributions are made or code is moved from one file to another. Sometimes people contribute significant patches but do not add a line claiming copyright. Other times, people add a copyright notice for their contribution but then a later refactoring moves part or all of their contribution to another file and the notice is not moved with the code. As a practical matter, moving such notices is difficult -- determining what parts are due to a particular contributor requires a time-consuming search through the project history. Even managing the yearly update of copyright years is problematic. We have some contributors who are no longer living. Should we update the copyright dates for their contributions when we release new versions? Probably not, but we do still want to claim copyright for the project as a whole. To minimize the difficulty of maintaining the copyright notices, I would like to change Octave's sources to use what is described here: https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html in the section "Maintaining centralized copyright notices": The centralized notice approach consolidates all copyright notices in a single location, usually a top-level file. This file should contain all of the copyright notices provided project contributors, unless the contribution was clearly insignificant. It may also credit -- without a copyright notice -- anyone who helped with the project but did not contribute code or other copyrighted material. This approach captures less information about contributions within individual files, recognizing that the DVCS is better equipped to record those details. As we mentioned before, it does have one disadvantage as compared to the file-scope approach: if a single file is separated from the distribution, the recipient won't see the contributors' copyright notices. But this can be easily remedied by including a single copyright notice in each file's header, pointing to the top-level file: Copyright YYYY-YYYY The Octave Project Developers See the COPYRIGHT file at the top-level directory of this distribution or at https://octave.org/COPYRIGHT.html. followed by the usual GPL copyright statement. For more background, see the discussion here: https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html Most files in the following directories have been skipped intentinally in this changeset: doc libgui/qterminal liboctave/external m4
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 15:38:17 -0500
parents 775643b5eae4
children 1891570abac8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26699
diff changeset
1 ## Copyright (C) 2008-2019 The Octave Project Developers
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26699
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26699
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26699
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26699
diff changeset
5 ##
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
6 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
7 ## This file is part of Octave.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
10 ## 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
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## (at your option) any later version.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
13 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
18 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
20 ## 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
21 ## <https://www.gnu.org/licenses/>.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
22
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20713
diff changeset
24 ## @deftypefn {} {@var{output} =} perl (@var{scriptfile})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20713
diff changeset
25 ## @deftypefnx {} {@var{output} =} perl (@var{scriptfile}, @var{argument1}, @var{argument2}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20713
diff changeset
26 ## @deftypefnx {} {[@var{output}, @var{status}] =} perl (@dots{})
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
27 ## Invoke Perl script @var{scriptfile}, possibly with a list of command line
19215
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
28 ## arguments.
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
29 ##
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
30 ## Return output in @var{output} and optional status in @var{status}. If
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 19697
diff changeset
31 ## @var{scriptfile} is not an absolute filename it is searched for in the
19215
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
32 ## current directory and then in the Octave loadpath.
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
33 ## @seealso{system, python}
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
34 ## @end deftypefn
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
35
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
36 function [output, status] = perl (scriptfile = "-e ''", varargin)
7679
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
37
26699
775643b5eae4 maint: Fix typos in comments where "intial" instead of "initial" used.
Rik <rik@octave.org>
parents: 26376
diff changeset
38 ## VARARGIN is initialized to {}(1x0) if no additional arguments are
7679
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
39 ## supplied, so there is no need to check for it, or provide an
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
40 ## initial value in the argument list of the function definition.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
41
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
42 if (ischar (scriptfile)
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
43 && ( (nargin == 1 && ! isempty (scriptfile))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
44 || (nargin != 1 && iscellstr (varargin))))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
45 if (! strcmp (scriptfile(1:2), "-e"))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
46 ## Attempt to find file in loadpath. No effect for absolute filenames.
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
47 scriptfile = file_in_loadpath (scriptfile);
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
48 endif
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
49
16994
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14818
diff changeset
50 [status, output] = system (["perl " scriptfile ...
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14818
diff changeset
51 sprintf(" %s", varargin{:})]);
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
52 else
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
53 error ("perl: invalid arguments");
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
54 endif
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
55
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
56 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 16994
diff changeset
57
19215
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
58
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
59 %!error <invalid arguments> perl (123)