Blame Manual/repository-html/repository_61.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>
5cb5a7
<title>CentOS Artwork Repository: 2.59 Filesystem/trunk/Scripts/Bash/Cli/Functions/Shell</title>
ee1f37
5cb5a7
<meta name="description" content="CentOS Artwork Repository: 2.59 Filesystem/trunk/Scripts/Bash/Cli/Functions/Shell">
5cb5a7
<meta name="keywords" content="CentOS Artwork Repository: 2.59 Filesystem/trunk/Scripts/Bash/Cli/Functions/Shell">
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
56a476
[ < ]
010b2d
[ > ]
ee1f37
   
982d5c
[ << ]
982d5c
[ Up ]
5cb5a7
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
56a476
[Top]
56a476
[Contents]
5cb5a7
[Index]
56a476
[ ? ]
ee1f37
982d5c
010b2d
5cb5a7

2.59 Filesystem/trunk/Scripts/Bash/Cli/Functions/Shell

ee1f37
ee1f37
010b2d
982d5c

2.59.1 Goals

ee1f37
982d5c

This section exists to organize files related to shell

010b2d
functionality of <tt>`centos-art.sh'</tt> script.
ee1f37

ee1f37
010b2d
982d5c

2.59.2 Description

ee1f37
982d5c

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

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

982d5c

When you use shell functionality to update copyright inside

982d5c
script files, it is required that your script files contain (at least)
982d5c
the following top commentary structure:
010b2d

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

Figure 2.4: The functions script base comment structure

982d5c
010b2d

982d5c

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

982d5c
Everything else in the file is left immutable.
010b2d

982d5c

When you are updating copyright through shell

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

982d5c
Caution

Caution

Be sure to add the long dash separator that matches

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

982d5c
982d5c

The copyright template instance is created from one copyright template

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

982d5c

When you use shell functionality to update copyright, the first

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

982d5c

When shell functionality uses its own default values, the final

982d5c
copyright note looks like the following:
010b2d

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

Figure 2.5: The function script comment example

982d5c
010b2d

982d5c

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

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

982d5c

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

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

982d5c

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

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

982d5c
Important

Important

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

010b2d

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

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

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

010b2d
010b2d
982d5c
982d5c

2.59.3 Usage

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

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

982d5c
under <samp>`path/to/dir'</samp> directory. 
010b2d

010b2d
010b2d
010b2d

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

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

010b2d
Warning

Warning

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

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

010b2d
982d5c

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

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

010b2d

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

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

ee1f37
982d5c
982d5c

2.59.4 See also

ee1f37
ee1f37
5cb5a7
2.49 Filesystem/trunk/Scripts/Bash  
ee1f37
ee1f37
ee1f37
ee1f37
ee1f37
982d5c
[ < ]
982d5c
[ > ]
ee1f37
   
982d5c
[ << ]
010b2d
[ Up ]
5cb5a7
[ >> ]
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>