Blame Manual/repository-html/repository_62.html

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>
b9dbd3
<title>CentOS Artwork Repository: 2.60 The trunk/Scripts/Bash/Cli/Functions/Shell Directory</title>
ee1f37
b9dbd3
<meta name="description" content="CentOS Artwork Repository: 2.60 The trunk/Scripts/Bash/Cli/Functions/Shell Directory">
b9dbd3
<meta name="keywords" content="CentOS Artwork Repository: 2.60 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
b9dbd3
[ < ]
b9dbd3
[ > ]
ee1f37
   
b9dbd3
[ << ]
b9dbd3
[ Up ]
b9dbd3
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
56a476
[Top]
56a476
[Contents]
b130a0
[Index]
56a476
[ ? ]
ee1f37
b9dbd3
b9dbd3
b9dbd3

2.60 The <tt>`trunk/Scripts/Bash/Cli/Functions/Shell'</tt> Directory

aaf678
aaf678
b9dbd3
b9dbd3

2.60.1 Goals

ee1f37
b9dbd3

This section exists to organize files related to shell

b130a0
functionality of <tt>`centos-art.sh'</tt> script.
aaf678

aaf678
b9dbd3
b9dbd3

2.60.2 Description

010b2d
b9dbd3

The shell functionality of <tt>`centos-art.sh'</tt> script helps

b9dbd3
you to maintain bash scripts inside repository. For example, suppose
b9dbd3
you've created many functionalities for <tt>`centos-art.sh'</tt> script,
b9dbd3
and you want to use a common copyright and license note for
b9dbd3
consistency in all your script files. If you have a bunch of files,
b9dbd3
doing this one by one wouldn't be a big deal. In contrast, if the
b9dbd3
amount of files grows, updating the copyright and license note for all
b9dbd3
of them would be a task rather tedious. The shell functionality
b9dbd3
exists to solve maintainance tasks just as the one previously
b9dbd3
mentioned.
b130a0

b9dbd3

When you use shell functionality to update copyright inside

b9dbd3
script files, it is required that your script files contain (at least)
b9dbd3
the following top commentary structure:
b130a0

b9dbd3
b9dbd3
 1| #!/bin/bash
b9dbd3
 2| #
b9dbd3
 3| # doSomething.sh -- The function description goes here.
b9dbd3
 4| # 
b9dbd3
 5| # Copyright
b9dbd3
 6| #
b9dbd3
 7| # ...
b9dbd3
 8| #
b9dbd3
 9| # ----------------------------------------------------------------------
b9dbd3
10| # $Id$
b9dbd3
11| # ----------------------------------------------------------------------
b9dbd3
12|
b9dbd3
13| function doSomething {
b9dbd3
14|     
b9dbd3
15| }
b9dbd3
b9dbd3

Figure 2.4: The functions script base comment structure

b9dbd3
b130a0

b9dbd3

Relevant lines in the above structure are lines from 5 to 9.

b9dbd3
Everything else in the file is left immutable.
010b2d

b9dbd3

When you are updating copyright through shell

b9dbd3
functionality,  the <tt>`centos-art.sh'</tt> script replaces everything
b9dbd3
in-between line 5 --the first one matching <samp>`^# Copyright .+$'</samp>
b9dbd3
string-- and line 9--the first long dash separator matching <samp>`^#
b9dbd3
-+$'</samp>-- with the content of copyright template instance.
010b2d

b9dbd3
Caution

Caution

Be sure to add the long dash separator that matches

b9dbd3
<samp>`^# -+$'</samp> regular expression before the function
b9dbd3
definition. Otherwise, if the <samp>`Copyright'</samp> line is present but no
b9dbd3
long dash separator exists, <tt>`centos-art.sh'</tt> will remove anything
b9dbd3
in-between the <samp>`Copyright'</samp> line and the end of file. This way you
b9dbd3
may lost your function definitions entirely.
b9dbd3

b9dbd3
b9dbd3

The copyright template instance is created from one copyright template

b9dbd3
stored in the <tt>`Config/tpl_forCopyright.sed'</tt> file.  The template
b9dbd3
instance is created once, and later removed when no longer needed. At
b9dbd3
this moment, when template instance is created, the
b9dbd3
<tt>`centos-art.sh'</tt> script takes advantage of automation in order to
b9dbd3
set copyright full name and date dynamically.
010b2d

b9dbd3

When you use shell functionality to update copyright, the first

b9dbd3
thing <tt>`shell'</tt> functionality does is requesting copyright
b9dbd3
information to user, and later, if values were left empty (i.e., no
b9dbd3
value was typed before pressing RET key), the <tt>`shell'</tt>
b9dbd3
functionality uses its own default values.
010b2d

b9dbd3

When shell functionality uses its own default values, the final

b9dbd3
copyright note looks like the following:
010b2d

b9dbd3
b9dbd3
 1| #!/bin/bash
b9dbd3
 2| #
b9dbd3
 3| # doSomthing.sh -- The function description goes here.
b9dbd3
 4| #
b9dbd3
 5| # Copyright (C) 2003, 2010 The CentOS Project
b9dbd3
 6| # 
b9dbd3
 7| # This program is free software; you can redistribute it and/or modify
b9dbd3
 8| # it under the terms of the GNU General Public License as published by
b9dbd3
 9| # the Free Software Foundation; either version 2 of the License, or
b9dbd3
10| # (at your option) any later version.
b9dbd3
11| # 
b9dbd3
12| # This program is distributed in the hope that it will be useful, but
b9dbd3
13| # WITHOUT ANY WARRANTY; without even the implied warranty of
b9dbd3
14| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
b9dbd3
15| # General Public License for more details.
b9dbd3
16| #
b9dbd3
17| # You should have received a copy of the GNU General Public License
b9dbd3
18| # along with this program; if not, write to the Free Software
b9dbd3
19| # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
b9dbd3
20| # USA.
b9dbd3
21| #
b9dbd3
22| # ----------------------------------------------------------------------
b9dbd3
23| # $Id$
b9dbd3
24| # ----------------------------------------------------------------------
b9dbd3
25|
b9dbd3
26| function doSomething {
b9dbd3
27|
b9dbd3
28| }
b9dbd3
b9dbd3

Figure 2.5: The function script comment example

b9dbd3
010b2d

b9dbd3

Relevant lines in the above structure are lines from 5 to 22. Pay

b9dbd3
attention how the copyright line was built, and how the license was
b9dbd3
added into the top comment where previously was just three dots.
b9dbd3
Everything else in the file was left immutable. 
010b2d

b9dbd3

To change copyright information (i.e., full name or year information),

b9dbd3
run the shell functionality over the root directory containing
b9dbd3
the script files you want to update copyright in and enter the
b9dbd3
appropriate information when it be requested. You can run the
b9dbd3
shell functionality as many times as you need to.
982d5c

b9dbd3

To change copyright license (i.e., the text in-between lines 7 and

b9dbd3
20), you need to edit the <tt>`Config/tpl_forCopyright.sed'</tt> file, set
b9dbd3
the appropriate information, and run the shell functionality
b9dbd3
once again for changes to take effect over the files you specify.
010b2d

b9dbd3
Important

Important

The <tt>`centos-art.sh'</tt> script is released as:

b130a0

b9dbd3
GNU GENERAL PUBLIC LICENSE
b9dbd3
Version 2, June 1991
b130a0
b9dbd3
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
b9dbd3
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
b9dbd3
b9dbd3

Do not change the license information under which <tt>`centos-art.sh'</tt>

b9dbd3
script is released. Instead, if you think a different license must be
b9dbd3
used, please share your reasons at CentOS Developers mailing list.
b9dbd3

b130a0
aaf678
b9dbd3
b9dbd3

2.60.3 Usage

982d5c
982d5c
b9dbd3
centos-art sh --update-copyright='path/to/dir'
b9dbd3
centos-art sh --update-copyright='path/to/dir' --filter='regex'
b9dbd3

Use these commands to update copyright information in <samp>`.sh'</samp> files

b9dbd3
under <samp>`path/to/dir'</samp> directory. 
b130a0

010b2d
010b2d
b130a0

When you provide <samp>`--filter='regex''</samp> argument, the list of files

b130a0
to process is reduced as specified in <samp>`regex'</samp> regular expression.
b130a0
Inside <tt>`centos-art.sh'</tt> script, the <samp>`regex'</samp> regular
b130a0
expression is used in combination with find command to look
b130a0
for files matching the regular expression path pattern.
b130a0

b130a0
Warning

Warning

In order for <samp>`regex'</samp> regular expression to match

b130a0
a file, the <samp>`regex'</samp> regular expresion must match the whole file
b130a0
path not just the file name. 
b130a0

b130a0
b9dbd3

For example, if you want to match all <tt>`render.conf.sh'</tt> files

b9dbd3
inside <tt>`path/to/dir'</tt>, use the .+/render.conf regular
b9dbd3
expression.  Later, <tt>`centos-art.sh'</tt> script uses this value inside
b9dbd3
^$REGEX\.sh$ expression in order to build the final regular
b9dbd3
expression (i.e., ^.+/render.conf\.sh$) that is evaluated
b9dbd3
against available file paths inside the list of files to process.
b130a0

b130a0

Exceptionally, when you provide <samp>`--filter='regex''</samp> in the way

b130a0
that <samp>`regex'</samp>, appended to <samp>`path/to/dir/'</samp> (i.e.
b130a0
<samp>`path/to/dir/regex'</samp>), matches a regular file; the
b130a0
<tt>`centos-art.sh'</tt> script uses the file matching as only file in the
b130a0
list of files to process. 
b130a0

982d5c
b9dbd3
b9dbd3

2.60.4 See also

ee1f37
010b2d
b9dbd3
2.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
010b2d
010b2d
ee1f37
ee1f37
ee1f37
b9dbd3
[ < ]
b9dbd3
[ > ]
ee1f37
   
b9dbd3
[ << ]
b9dbd3
[ Up ]
b9dbd3
[ >> ]
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>