|
 |
ee1f37 |
|
|
|
ee1f37 |
<html>
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
Permission is granted to copy, distribute and/or modify this document
|
|
|
ee1f37 |
under the terms of the GNU Free Documentation License, Version 1.2 or
|
|
|
ee1f37 |
any later version published by the Free Software Foundation; with no
|
|
|
ee1f37 |
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
|
|
|
ee1f37 |
copy of the license is included in the section entitled GNU Free
|
|
|
ee1f37 |
Documentation License.
|
|
|
ee1f37 |
-->
|
|
|
406f69 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
|
|
|
ee1f37 |
Karl Berry <karl@freefriends.org>
|
|
|
ee1f37 |
Olaf Bachmann <obachman@mathematik.uni-kl.de>
|
|
|
ee1f37 |
and many others.
|
|
|
ee1f37 |
Maintained by: Many creative people <dev@texi2html.cvshome.org>
|
|
|
ee1f37 |
Send bugs and suggestions to <users@texi2html.cvshome.org>
|
|
|
ee1f37 |
|
|
|
ee1f37 |
-->
|
|
|
ee1f37 |
<head>
|
|
|
861ed3 |
<title>CentOS Artwork Repository: 1.59 The trunk/Scripts/Bash/Cli/Functions/Shell Directory</title>
|
|
|
ee1f37 |
|
|
|
861ed3 |
<meta name="description" content="CentOS Artwork Repository: 1.59 The trunk/Scripts/Bash/Cli/Functions/Shell Directory">
|
|
|
861ed3 |
<meta name="keywords" content="CentOS Artwork Repository: 1.59 The trunk/Scripts/Bash/Cli/Functions/Shell Directory">
|
|
|
ee1f37 |
<meta name="resource-type" content="document">
|
|
|
ee1f37 |
<meta name="distribution" content="global">
|
|
|
ee1f37 |
<meta name="Generator" content="texi2html 1.76">
|
|
|
ee1f37 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
|
ee1f37 |
<style type="text/css">
|
|
|
ee1f37 |
|
|
|
ee1f37 |
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";
|
|
|
ee1f37 |
|
|
|
ee1f37 |
a.summary-letter {text-decoration: none}
|
|
|
ee1f37 |
pre.display {font-family: serif}
|
|
|
ee1f37 |
pre.format {font-family: serif}
|
|
|
ee1f37 |
pre.menu-comment {font-family: serif}
|
|
|
ee1f37 |
pre.menu-preformatted {font-family: serif}
|
|
|
ee1f37 |
pre.smalldisplay {font-family: serif; font-size: smaller}
|
|
|
ee1f37 |
pre.smallexample {font-size: smaller}
|
|
|
ee1f37 |
pre.smallformat {font-family: serif; font-size: smaller}
|
|
|
ee1f37 |
pre.smalllisp {font-size: smaller}
|
|
|
ee1f37 |
span.sansserif {font-family:sans-serif; font-weight:normal;}
|
|
|
ee1f37 |
ul.toc {list-style: none}
|
|
|
ee1f37 |
-->
|
|
|
ee1f37 |
</style>
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
</head>
|
|
|
ee1f37 |
|
|
|
ee1f37 |
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
aaf678 |
[ < ]
|
|
|
aaf678 |
[ > ]
|
|
|
ee1f37 |
|
|
|
aaf678 |
[ << ]
|
|
|
aaf678 |
[ Up ]
|
|
|
aaf678 |
[ >> ]
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
56a476 |
[Top]
|
|
|
56a476 |
[Contents]
|
|
|
5cb5a7 |
[Index]
|
|
|
56a476 |
[ ? ]
|
|
|
ee1f37 |
|
|
|
aaf678 |
|
|
|
aaf678 |
|
|
|
861ed3 |
1.59 The <tt>`trunk/Scripts/Bash/Cli/Functions/Shell'</tt> Directory
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
aaf678 |
|
|
|
aaf678 |
1.59.1 Goals
|
|
|
ee1f37 |
|
|
|
aaf678 |
This section exists to organize files related to shell
|
|
|
aaf678 |
functionality of <tt>`centos-art.sh'</tt> script.
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
aaf678 |
|
|
|
aaf678 |
1.59.2 Description
|
|
|
aaf678 |
|
|
|
aaf678 |
The shell functionality of <tt>`centos-art.sh'</tt> script helps
|
|
|
aaf678 |
you to maintain bash scripts inside repository. For example, suppose
|
|
|
aaf678 |
you've created many functionalities for <tt>`centos-art.sh'</tt> script,
|
|
|
aaf678 |
and you want to use a common copyright and license note for
|
|
|
aaf678 |
consistency in all your script files. If you have a bunch of files,
|
|
|
aaf678 |
doing this one by one wouldn't be a big deal. In contrast, if the
|
|
|
aaf678 |
amount of files grows, updating the copyright and license note for all
|
|
|
aaf678 |
of them would be a task rather tedious. The shell functionality
|
|
|
aaf678 |
exists to solve maintainance tasks just as the one previously
|
|
|
aaf678 |
mentioned.
|
|
|
010b2d |
|
|
|
aaf678 |
When you use shell functionality to update copyright inside
|
|
|
aaf678 |
script files, it is required that your script files contain (at least)
|
|
|
aaf678 |
the following top commentary structure:
|
|
|
010b2d |
|
|
|
aaf678 |
|
|
|
aaf678 |
1| #!/bin/bash
|
|
|
aaf678 |
2| #
|
|
|
aaf678 |
3| # doSomething.sh -- The function description goes here.
|
|
|
aaf678 |
4| #
|
|
|
aaf678 |
5| # Copyright
|
|
|
aaf678 |
6| #
|
|
|
aaf678 |
7| # ...
|
|
|
aaf678 |
8| #
|
|
|
aaf678 |
9| # ----------------------------------------------------------------------
|
|
|
aaf678 |
10| # $Id$
|
|
|
aaf678 |
11| # ----------------------------------------------------------------------
|
|
|
aaf678 |
12|
|
|
|
aaf678 |
13| function doSomething {
|
|
|
aaf678 |
14|
|
|
|
aaf678 |
15| }
|
|
|
010b2d |
|
|
|
aaf678 |
Figure 1.4: The functions script base comment structure
|
|
|
aaf678 |
|
|
|
010b2d |
|
|
|
aaf678 |
Relevant lines in the above structure are lines from 5 to 9.
|
|
|
aaf678 |
Everything else in the file is left immutable.
|
|
|
010b2d |
|
|
|
aaf678 |
When you are updating copyright through shell
|
|
|
aaf678 |
functionality, the <tt>`centos-art.sh'</tt> script replaces everything
|
|
|
aaf678 |
in-between line 5 --the first one matching <samp>`^# Copyright .+$'</samp>
|
|
|
aaf678 |
string-- and line 9--the first long dash separator matching <samp>`^#
|
|
|
aaf678 |
-+$'</samp>-- with the content of copyright template instance.
|
|
|
010b2d |
|
|
|
aaf678 |
 Caution Be sure to add the long dash separator that matches
|
|
|
aaf678 |
<samp>`^# -+$'</samp> regular expression before the function
|
|
|
aaf678 |
definition. Otherwise, if the <samp>`Copyright'</samp> line is present but no
|
|
|
aaf678 |
long dash separator exists, <tt>`centos-art.sh'</tt> will remove anything
|
|
|
aaf678 |
in-between the <samp>`Copyright'</samp> line and the end of file. This way you
|
|
|
aaf678 |
may lost your function definitions entirely.
|
|
|
aaf678 |
|
|
|
ee1f37 |
|
|
|
aaf678 |
The copyright template instance is created from one copyright template
|
|
|
aaf678 |
stored in the <tt>`Config/tpl_forCopyright.sed'</tt> file. The template
|
|
|
aaf678 |
instance is created once, and later removed when no longer needed. At
|
|
|
aaf678 |
this moment, when template instance is created, the
|
|
|
aaf678 |
<tt>`centos-art.sh'</tt> script takes advantage of automation in order to
|
|
|
aaf678 |
set copyright full name and date dynamically.
|
|
|
010b2d |
|
|
|
aaf678 |
When you use shell functionality to update copyright, the first
|
|
|
aaf678 |
thing <tt>`shell'</tt> functionality does is requesting copyright
|
|
|
aaf678 |
information to user, and later, if values were left empty (i.e., no
|
|
|
aaf678 |
value was typed before pressing RET key), the <tt>`shell'</tt>
|
|
|
aaf678 |
functionality uses its own default values.
|
|
|
010b2d |
|
|
|
aaf678 |
When shell functionality uses its own default values, the final
|
|
|
aaf678 |
copyright note looks like the following:
|
|
|
010b2d |
|
|
|
aaf678 |
|
|
|
aaf678 |
1| #!/bin/bash
|
|
|
aaf678 |
2| #
|
|
|
aaf678 |
3| # doSomthing.sh -- The function description goes here.
|
|
|
aaf678 |
4| #
|
|
|
aaf678 |
5| # Copyright (C) 2003, 2010 The CentOS Project
|
|
|
aaf678 |
6| #
|
|
|
aaf678 |
7| # This program is free software; you can redistribute it and/or modify
|
|
|
aaf678 |
8| # it under the terms of the GNU General Public License as published by
|
|
|
aaf678 |
9| # the Free Software Foundation; either version 2 of the License, or
|
|
|
aaf678 |
10| # (at your option) any later version.
|
|
|
aaf678 |
11| #
|
|
|
aaf678 |
12| # This program is distributed in the hope that it will be useful, but
|
|
|
aaf678 |
13| # WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
aaf678 |
14| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
aaf678 |
15| # General Public License for more details.
|
|
|
aaf678 |
16| #
|
|
|
aaf678 |
17| # You should have received a copy of the GNU General Public License
|
|
|
aaf678 |
18| # along with this program; if not, write to the Free Software
|
|
|
aaf678 |
19| # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
|
aaf678 |
20| # USA.
|
|
|
aaf678 |
21| #
|
|
|
aaf678 |
22| # ----------------------------------------------------------------------
|
|
|
aaf678 |
23| # $Id$
|
|
|
aaf678 |
24| # ----------------------------------------------------------------------
|
|
|
aaf678 |
25|
|
|
|
aaf678 |
26| function doSomething {
|
|
|
aaf678 |
27|
|
|
|
aaf678 |
28| }
|
|
|
010b2d |
|
|
|
aaf678 |
Figure 1.5: The function script comment example
|
|
|
aaf678 |
|
|
|
010b2d |
|
|
|
aaf678 |
Relevant lines in the above structure are lines from 5 to 22. Pay
|
|
|
aaf678 |
attention how the copyright line was built, and how the license was
|
|
|
aaf678 |
added into the top comment where previously was just three dots.
|
|
|
aaf678 |
Everything else in the file was left immutable.
|
|
|
010b2d |
|
|
|
aaf678 |
To change copyright information (i.e., full name or year information),
|
|
|
aaf678 |
run the shell functionality over the root directory containing
|
|
|
aaf678 |
the script files you want to update copyright in and enter the
|
|
|
aaf678 |
appropriate information when it be requested. You can run the
|
|
|
aaf678 |
shell functionality as many times as you need to.
|
|
|
010b2d |
|
|
|
aaf678 |
To change copyright license (i.e., the text in-between lines 7 and
|
|
|
aaf678 |
20), you need to edit the <tt>`Config/tpl_forCopyright.sed'</tt> file, set
|
|
|
aaf678 |
the appropriate information, and run the shell functionality
|
|
|
aaf678 |
once again for changes to take effect over the files you specify.
|
|
|
010b2d |
|
|
|
aaf678 |
 Important The <tt>`centos-art.sh'</tt> script is released as:
|
|
|
982d5c |
|
|
|
aaf678 |
GNU GENERAL PUBLIC LICENSE
|
|
|
aaf678 |
Version 2, June 1991
|
|
|
ee1f37 |
|
|
|
aaf678 |
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
|
|
aaf678 |
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
|
982d5c |
|
|
|
aaf678 |
Do not change the license information under which <tt>`centos-art.sh'</tt>
|
|
|
aaf678 |
script is released. Instead, if you think a different license must be
|
|
|
aaf678 |
used, please share your reasons at CentOS Developers mailing list.
|
|
|
aaf678 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
aaf678 |
|
|
|
aaf678 |
1.59.3 Usage
|
|
|
aaf678 |
|
|
|
ee1f37 |
|
|
|
aaf678 |
centos-art sh --update-copyright='path/to/dir'
|
|
|
aaf678 |
centos-art sh --update-copyright='path/to/dir' --filter='regex'
|
|
|
aaf678 |
Use these commands to update copyright information in <samp>`.sh'</samp> files
|
|
|
aaf678 |
under <samp>`path/to/dir'</samp> directory.
|
|
|
aaf678 |
|
|
|
982d5c |
|
|
|
982d5c |
|
|
|
aaf678 |
When you provide <samp>`--filter='regex''</samp> argument, the list of files
|
|
|
aaf678 |
to process is reduced as specified in <samp>`regex'</samp> regular expression.
|
|
|
aaf678 |
Inside <tt>`centos-art.sh'</tt> script, the <samp>`regex'</samp> regular
|
|
|
aaf678 |
expression is used in combination with find command to look
|
|
|
aaf678 |
for files matching the regular expression path pattern.
|
|
|
aaf678 |
|
|
|
aaf678 |
 Warning In order for <samp>`regex'</samp> regular expression to match
|
|
|
aaf678 |
a file, the <samp>`regex'</samp> regular expresion must match the whole file
|
|
|
aaf678 |
path not just the file name.
|
|
|
aaf678 |
|
|
|
aaf678 |
|
|
|
aaf678 |
For example, if you want to match all <tt>`render.conf.sh'</tt> files
|
|
|
aaf678 |
inside <tt>`path/to/dir'</tt>, use the .+/render.conf regular
|
|
|
aaf678 |
expression. Later, <tt>`centos-art.sh'</tt> script uses this value inside
|
|
|
aaf678 |
^$REGEX\.sh$ expression in order to build the final regular
|
|
|
aaf678 |
expression (i.e., ^.+/render.conf\.sh$) that is evaluated
|
|
|
aaf678 |
against available file paths inside the list of files to process.
|
|
|
aaf678 |
|
|
|
aaf678 |
Exceptionally, when you provide <samp>`--filter='regex''</samp> in the way
|
|
|
aaf678 |
that <samp>`regex'</samp>, appended to <samp>`path/to/dir/'</samp> (i.e.
|
|
|
aaf678 |
<samp>`path/to/dir/regex'</samp>), matches a regular file; the
|
|
|
aaf678 |
<tt>`centos-art.sh'</tt> script uses the file matching as only file in the
|
|
|
aaf678 |
list of files to process.
|
|
|
010b2d |
|
|
|
ee1f37 |
|
|
|
aaf678 |
|
|
|
aaf678 |
1.59.4 See also
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
861ed3 |
1.49 The <tt>`trunk/Scripts/Bash'</tt> Directory
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
aaf678 |
[ < ]
|
|
|
aaf678 |
[ > ]
|
|
|
ee1f37 |
|
|
|
aaf678 |
[ << ]
|
|
|
aaf678 |
[ Up ]
|
|
|
aaf678 |
[ >> ]
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
<font size="-1">
|
|
|
406f69 |
This document was generated on March, 1 2011 using texi2html 1.76.
|
|
|
ee1f37 |
</font>
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
|
|
|
ee1f37 |
</body>
|
|
|
ee1f37 |
</html>
|