Blame Manuals/en/Html/Repository/repository_45.html

4c79b5
4c79b5
<html>
09d4f2
09d4f2
09d4f2
The CentOS Artwork Repository exists to organize and automate The
09d4f2
CentOS Project corporate visual identity (, to
09d4f2
start on).
4c79b5
6c4982
Copyright C 2009, 2010 Alain Reguera Delgado. All rights
4c79b5
reserved.
4c79b5
4c79b5
Permission is granted to copy, distribute and/or modify this document
4c79b5
under the terms of the GNU Free Documentation License, Version 1.2 or
4c79b5
any later version published by the Free Software Foundation; with no
4c79b5
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
4c79b5
copy of the license is included in the section entitled GNU Free
4c79b5
Documentation License.  
4c79b5
-->
09d4f2
4c79b5
4c79b5
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
4c79b5
            Karl Berry  <karl@freefriends.org>
4c79b5
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
4c79b5
            and many others.
4c79b5
Maintained by: Many creative people <dev@texi2html.cvshome.org>
4c79b5
Send bugs and suggestions to <users@texi2html.cvshome.org>
4c79b5
4c79b5
-->
4c79b5
<head>
2c8180
<title>CentOS Artwork Repository: 3.42 trunk/Scripts/Bash/Functions/Shell</title>
4c79b5
2c8180
<meta name="description" content="CentOS Artwork Repository: 3.42 trunk/Scripts/Bash/Functions/Shell">
2c8180
<meta name="keywords" content="CentOS Artwork Repository: 3.42 trunk/Scripts/Bash/Functions/Shell">
4c79b5
<meta name="resource-type" content="document">
4c79b5
<meta name="distribution" content="global">
4c79b5
<meta name="Generator" content="texi2html 1.76">
4c79b5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4c79b5
<style type="text/css">
4c79b5
1e9202
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";
4c79b5
4c79b5
a.summary-letter {text-decoration: none}
4c79b5
pre.display {font-family: serif}
4c79b5
pre.format {font-family: serif}
4c79b5
pre.menu-comment {font-family: serif}
4c79b5
pre.menu-preformatted {font-family: serif}
4c79b5
pre.smalldisplay {font-family: serif; font-size: smaller}
4c79b5
pre.smallexample {font-size: smaller}
4c79b5
pre.smallformat {font-family: serif; font-size: smaller}
4c79b5
pre.smalllisp {font-size: smaller}
4c79b5
span.sansserif {font-family:sans-serif; font-weight:normal;}
4c79b5
ul.toc {list-style: none}
4c79b5
-->
4c79b5
</style>
4c79b5
4c79b5
4c79b5
</head>
4c79b5
4c79b5
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
4c79b5
4c79b5
09d4f2
[ < ]
09d4f2
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
09d4f2
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
09d4f2
[Index]
4c79b5
[ ? ]
4c79b5
2c8180
09d4f2
2c8180

3.42 trunk/Scripts/Bash/Functions/Shell

38bcd9
fe989b
09d4f2
b8013f

3.42.1 Goals

b8013f
915635

This section exists to organize files related to shell

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

fe989b
09d4f2
b8013f

3.42.2 Description

fe989b
915635

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

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

915635

When you use shell functionality to update copyright inside

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

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

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

915635
Everything else in the file is left immutable.
915635

915635

When you are updating copyright through shell

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

915635
Caution

Caution

Be sure to add the long dash separator that matches

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

915635
915635

The copyright template instance is created from one copyright template

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

915635

When you use shell functionality to update copyright, the first

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

915635

When shell functionality uses its own default values, the final

915635
copyright note looks like the following:
915635

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

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

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

915635

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

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

915635

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

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

915635
Important

Important

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

915635

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

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

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

fe989b
fe989b
09d4f2
fe989b

3.42.3 Usage

fe989b
915635
915635
centos-art sh --update-copyright='path/to/dir'
915635
centos-art sh --update-copyright='path/to/dir' --filter='regex'
915635

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

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

915635
fe989b
915635

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

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

915635
Warning

Warning

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

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

915635
915635

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

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

915635

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

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

fe989b
09d4f2
54264c

3.42.4 See also

4c79b5
915635
915635
3.34 trunk/Scripts/Bash  
915635
915635
3.35 trunk/Scripts/Bash/Functions  
915635
915635
4c79b5
4c79b5
4c79b5
09d4f2
[ < ]
09d4f2
[ > ]
4c79b5
   
4c79b5
[ << ]
09d4f2
[ Up ]
09d4f2
[ >> ]
4c79b5
4c79b5

4c79b5
 <font size="-1">
09d4f2
  This document was generated on November, 21 2010 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

4c79b5
</body>
4c79b5
</html>