Blame Manuals/Repository/repository-html/repository_56.html

4c79b5
4c79b5
<html>
ccb7a3
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
-->
bf28e1
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>
7e35dc
<title>CentOS Artwork Repository: 3.53 trunk/Scripts/Bash/Functions/Path</title>
4c79b5
7e35dc
<meta name="description" content="CentOS Artwork Repository: 3.53 trunk/Scripts/Bash/Functions/Path">
7e35dc
<meta name="keywords" content="CentOS Artwork Repository: 3.53 trunk/Scripts/Bash/Functions/Path">
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
af3979
[ < ]
af3979
[ > ]
4c79b5
   
300762
[ << ]
300762
[ Up ]
af3979
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
af3979
[Index]
4c79b5
[ ? ]
4c79b5
7e35dc
af3979
7e35dc

3.53 trunk/Scripts/Bash/Functions/Path

2dc146
2dc146
af3979
2dc146

3.53.1 Goals

2dc146
7e35dc

This section exists to organize files related to path

7e35dc
functiontionality.  The path functionality standardizes
7e35dc
movement, syncronization, branching, tagging, and general file
7e35dc
maintainance inside the repository. 
7e35dc

2dc146
af3979
2dc146

3.53.2 Description

2dc146
7e35dc

"CentOS like trees, has roots, trunk, branches, leaves and

7e35dc
flowers.  Day by day they work together in freedom, ruled by the laws
7e35dc
of nature and open standards, to show the beauty of its existence."
7e35dc

c2a1bc
af3979
7e35dc

3.53.2.1 Repository layout

7e35dc
7e35dc

The repository layout describes organization of files and directories

7e35dc
inside the repository. The repository layout provides the standard
7e35dc
backend required for automation scripts to work correctly. If such
7e35dc
layout changes unexpectedly, automation scripts may confuse themselves
7e35dc
and stop doing what we expect from them to do.
7e35dc

7e35dc

As convenction, inside CentOS Artwork Repository, we organize files

7e35dc
and directories related to CentOS corporate visual identity under
7e35dc
three top level directories named: <tt>`trunk/'</tt>, <tt>`branches/'</tt>,
7e35dc
and <tt>`tags/'</tt>. 
7e35dc

7e35dc

The <tt>`trunk/'</tt> directory (see section trunk) organizes the main

7e35dc
development line of CentOS corporate visual identity. Inside
7e35dc
<tt>`trunk/'</tt> directory structure, the CentOS corporate visual
7e35dc
identity concepts are implemented using directories.  There is one
7e35dc
directory level for each relevant concept inside the repository. The
7e35dc
<tt>`trunk/'</tt> directory structure is mainly used to perform
7e35dc
development tasks related to CentOS corporate visual identity.
7e35dc

7e35dc

The <tt>`branches/'</tt> directory (see section branches) oranizes parallel

7e35dc
development lines to <tt>`trunk/'</tt> directory. The <tt>`branches/'</tt>
7e35dc
directory is used to set points in time where develpment lines are
7e35dc
devided one from another taking separte and idependent lives that
7e35dc
share a common past from the point they were devided on. The
7e35dc
<tt>`branches/'</tt> directory is mainly used to perform quality assurance
7e35dc
tasks related to CentOS corporate visual identity.
7e35dc

7e35dc

The <tt>`tags/'</tt> directory (see section tags) organizes parallel frozen

7e35dc
lines to <tt>`branches/'</tt> directory.  The parallel frozen lines are
7e35dc
immutable, nothing change inside them once they has been created.  The
7e35dc
<tt>`tags/'</tt> directory is mainly used to publish final releases of
7e35dc
CentOS corporate visual identity.
7e35dc

7e35dc

The CentOS Artwork Repository layout is firmly grounded on a

7e35dc
Subversion base.  Subversion (http://subversion.tigris.org) is a
7e35dc
version control system, which allows you to keep old versions of files
7e35dc
and directories (usually source code), keep a log of who, when, and
7e35dc
why changes occurred, etc., like CVS, RCS or SCCS.  Subversion keeps a
7e35dc
single copy of the master sources.  This copy  is called the source
7e35dc
"repository"; it contains all the information to permit extracting
7e35dc
previous versions of those files at any time.
7e35dc

7e35dc
af3979
7e35dc

3.53.2.2 Repository name convenctions

7e35dc
7e35dc

Repository name convenctions help us to maintain consistency of names

7e35dc
inside the repository.
7e35dc

7e35dc

Repository name convenctions are applied to files and directories

7e35dc
inside the repository layout. As convenction, inside the repository
7e35dc
layout, file names are all written in lowercase
7e35dc
(<samp>`01-welcome.png'</samp>, <samp>`splash.png'</samp>, <samp>`anaconda_header.png'</samp>,
7e35dc
etc.) and directory names are all written capitalized (e.g.,
7e35dc
<samp>`Identity'</samp>, <samp>`Themes'</samp>, <samp>`Motifs'</samp>, <samp>`TreeFlower'</samp>,
7e35dc
etc.).
7e35dc

7e35dc

Repository name convenctions are implemented inside the

7e35dc
cli_getRepoName function of <tt>`centos-art.sh'</tt> script. With
7e35dc
cli_getRepoName function we reduce the amount of commands and
7e35dc
convenctions to remember, concentrating them in just one single place
7e35dc
to look for fixes and improvements.
7e35dc

7e35dc
af3979
7e35dc

3.53.2.3 Repository work flow

7e35dc
7e35dc

Repository work flow describes the steps and time intervals used to

7e35dc
produce CentOS corporate visual identity inside CentOS Artwork
7e35dc
Repository.  
7e35dc

7e35dc

To illustrate repository work flow let's consider themes' development

7e35dc
cycle. 
7e35dc

7e35dc

Initially, we start working themes on their trunk development line

7e35dc
(e.g., <tt>`trunk/Identity/Themes/Motifs/TreeFlower/'</tt>), here we
7e35dc
organize information that cannot be produced automatically (i.e.,
7e35dc
background images, concepts, color information, screenshots, etc.).
7e35dc

7e35dc

Later, when theme trunk development line is considered "ready" for

7e35dc
implementation (e.g.,  all required backgrounds have been designed),
7e35dc
we create a branch for it (e.g.,
7e35dc
<tt>`branches/Identity/Themes/Motifs/TreeFlower/1/'</tt>).  Once the
7e35dc
branch has been created, we forget that branch and continue working
7e35dc
the trunk development line while others (e.g., an artwork quality
7e35dc
assurance team) test the new branch for tunning it up. 
7e35dc

7e35dc

Once the branch has been tunned up, and considered "ready" for

7e35dc
release, it is freezed under <tt>`tags/'</tt> directory (e.g.,
7e35dc
<tt>`tags/Identity/Themes/Motifs/TreeFower/1.0/'</tt>) for packagers,
7e35dc
webmasters, promoters, and anyone who needs images from that CentOS
7e35dc
theme the tag was created for.
7e35dc

7e35dc

Both branches and tags, inside CentOS Artwork Repository, use

7e35dc
numerical values to identify themselves under the same location.
7e35dc
Branches start at one (i.e., <samp>`1'</samp>) and increment one unit for each
7e35dc
branch created from the same trunk development line.  Tags start at
7e35dc
zero (i.e., <samp>`0'</samp>) and increment one unit for each tag created from
7e35dc
the same branch development line.
7e35dc

7e35dc
Convenction

Convenction

Do not freeze trunk development lines using tags

7e35dc
directly.  If you think you need to freeze a trunk development line,
7e35dc
create a branch for it and then freeze that branch instead.
7e35dc

7e35dc
7e35dc

The trunk development line may introduce problems we cannot see

7e35dc
immediatly. Certainly, the high changable nature of trunk development
7e35dc
line complicates finding and fixing such problems. On the other hand,
7e35dc
the branched development lines provide a more predictable area where
7e35dc
only fixes/corrections to current content are commited up to
7e35dc
repository. 
7e35dc

7e35dc

If others find and fix bugs inside the branched development line, we

7e35dc
could merge such changes/experiences back to trunk development line
7e35dc
(not visversa) in order for future branches, created from trunk, to
7e35dc
benefit.
7e35dc

7e35dc

Time intervals used to create branches and tags may vary, just as

7e35dc
different needs may arrive. For example, consider the release schema
7e35dc
of CentOS distribution: one major release every 2 years, security
7e35dc
updates every 6 months, support for 7 years long. Each time a CentOS
7e35dc
distribution is released, specially if it is a major release, there is
7e35dc
a theme need in order to cover CentOS distribution artwork
7e35dc
requirements. At this point, is where CentOS Artwork Repository comes
7e35dc
up to scene. 
7e35dc

7e35dc

Before releasing a new major release of CentOS distribution we create

7e35dc
a branch for one of several theme development lines available inside
7e35dc
the CentOS Artwork Repository, perform quality assurance on it, and
7e35dc
later, freeze that branch using tags. Once a the theme branch has been
7e35dc
frozen (under <tt>`tags/'</tt> directory), CentOS Packagers (the persons
7e35dc
whom build CentOS distribution) can use that frozen branch as source
7e35dc
location to fulfill CentOS distribution artwork needs. The same
7e35dc
applies to CentOS Webmasters (the persons whom build CentOS websites),
7e35dc
and any other visual manifestation required by the project.
7e35dc

7e35dc
af3979
7e35dc

3.53.2.4 Parallel directories

7e35dc
7e35dc

Inside CentOS Artwork Repository, parallel directories are simple

7e35dc
directory entries built from a common parent directory and placed in a
7e35dc
location different to that, the common parent directory is placed on.
7e35dc
Parallel directories are useful to create branches, tags,
7e35dc
translations, documentation, pre-rendering configuration script, and
7e35dc
similar directory structures.
7e35dc

7e35dc

Parallel directories take their structure from one unique parent

7e35dc
directory. Inside CentOS Artwork Repository, this unique parent
7e35dc
directory is under <tt>`trunk/Identity'</tt> location.  The
7e35dc
<tt>`trunk/Identity'</tt> location must be considered the reference for
7e35dc
whatever information you plan to create inside the repository.
7e35dc

7e35dc

In some circumstances, parallel directories may be created removing

7e35dc
uncommon information from their paths. Uncommon path information
7e35dc
refers to those directory levels in the path which are not common for
7e35dc
other parallel directories.  For example, when rendering
7e35dc
<tt>`trunk/Identity/Themes/Motifs/TreeFlower/Distro'</tt> directory
7e35dc
structure, the <tt>`centos-art.sh'</tt> script removes the
7e35dc
<tt>`Motifs/TreeFlower/'</tt> directory levels from path, in order to
7e35dc
build the parallel directory used to retrived translations, and
7e35dc
pre-rendering configuration scripts required by render
7e35dc
functionality.
7e35dc

7e35dc

Another example of parallel directory is the documentation structure

7e35dc
created by manual functionality. This time,
7e35dc
<tt>`centos-art.sh'</tt> script uses parallel directory information with
7e35dc
uncommon directory levels to build the documentation entry required by
7e35dc
Texinfo documentation system, inside the repository.
7e35dc

7e35dc

Othertimes, parallel directories may add uncommon information to their

7e35dc
paths. This is the case we use to create branches and tags. When we
7e35dc
create branches and tags, a numerical identifier is added to parallel
7e35dc
directory structure path. The place where the numerical identifier is
7e35dc
set on is relevant to corporate visual identity structure and should
7e35dc
be carefully considered where it will be.
7e35dc

7e35dc

When one parent directory changes, all their related parallel

7e35dc
directories need to be changed too. This is required in order for
7e35dc
parallel directories to retain their relation with the parent
7e35dc
directory structure.  In the other hand, parallel directories should
7e35dc
never be modified under no reason but to satisfy the relation to their
7e35dc
parent directory structure.  Liberal change of parallel directories
7e35dc
may suppresses the conceptual idea they were initially created for;
7e35dc
and certainly, things may stop working the way they should do.
7e35dc

7e35dc
af3979
7e35dc

3.53.2.5 Syncronizing path information

7e35dc
7e35dc

Parallel directories are very useful to keep repository organized but

7e35dc
introduce some complications.  For instance, consider what would
7e35dc
happen to functionalities like manual (<samp>`trunk Scripts Bash
7e35dc
Functions Manual'</samp>) that rely on parent directory structures to create
7e35dc
documentation entries (using parallel directory structures) if one of
7e35dc
those parent directory structures suddenly changes after the
7e35dc
documentation entry has been already created for it? 
7e35dc

7e35dc

In such cases, functionalities like manual may confuse

7e35dc
themselves if path information is not updated to reflect the relation
7e35dc
with its parent directory.  Such functionalities work with parent
7e35dc
directory structure as reference; if a parent directory changes, the
7e35dc
functionalities dont't even note it because they work with the last
7e35dc
parent directory structure available in the repository, no matter what
7e35dc
it is. 
7e35dc

7e35dc

In the specific case of documentation (the manual

7e35dc
functionality), the problem mentioned above provokes that older parent
7e35dc
directories, already documented, remain inside documentation directory
7e35dc
structures as long as you get your hands into the documentation
7e35dc
directory structure (<tt>`trunk/Manuals'</tt>) and change what must be
7e35dc
changed to match the new parent directory structure.
7e35dc

7e35dc

There is no immediate way for manual, and similar

7e35dc
functionalities that use parent directories as reference, to know when
7e35dc
and how directory movements take place inside the repository. Such
7e35dc
information is available only when the file movement itself takes
7e35dc
place inside the repository. So, is there, at the moment of moving
7e35dc
files, when we need to syncronize parallel directories with their
7e35dc
unique parent directory structure.
7e35dc

7e35dc
Warning

Warning

There is not support for URL reference inside

7e35dc
<tt>`centos-art.sh'</tt> script.  The <tt>`centos-art.sh'</tt> script is
7e35dc
designed to work with local files inside the working copy only.
7e35dc

7e35dc
7e35dc

As CentOS Artwork Repository is built over a version control system,

7e35dc
file movements inside the repository are considered repository
7e35dc
changes. In order for these repository changes to be versioned, we
7e35dc
need to, firstly, add changes into the version control system, commit
7e35dc
them, and later, perform movement actions using version control system
7e35dc
commands. This configuration makes possible for everyone to know about
7e35dc
changes details inside the repository; and if needed, revert or update
7e35dc
them back to a previous revision.
7e35dc

7e35dc

Finally, once all path information has been corrected, it is time to

7e35dc
take care of information inside the files. For instance, considere
7e35dc
what would happen if you make a reference to a documentation node, and
7e35dc
later the documentation node you refere to is deleted. That would make
7e35dc
Texinfo to produce error messages at export time. So, the
7e35dc
<tt>`centos-art.sh'</tt> script needs to know when such changes happen, in
7e35dc
a way they could be noted and handled without producing errors.
7e35dc

7e35dc
af3979
7e35dc

3.53.2.6 What is the right place to store it?

7e35dc
7e35dc

Occasionly, you may find that new corporate visual identity components

7e35dc
need to be added to the repository. If that is your case, the first
7e35dc
question you need to ask yourself, before start to create directories
7e35dc
blindly all over, is: What is the right place to store it?
7e35dc

7e35dc

The CentOS Community different free support vains (see:

7e35dc
http://wiki.centos.org/GettingHelp) are the best place to find
7e35dc
answers to your question, but going there with hands empty is not good
7e35dc
idea. It may give the impression you don't really care about. Instead,
7e35dc
consider the following suggestions to find your own comprehension and
7e35dc
so, make your propositions based on it.
7e35dc

7e35dc

When we are looking for the correct place to store new files, to bear

7e35dc
in mind the corporate visual identity structure used inside the CentOS
7e35dc
Artwork Repository (see section trunk/Identity) would be probaly the best
7e35dc
advice we could offer, the rest is just matter of choosing appropriate
7e35dc
names.  To illustrate this desition process let's consider the
7e35dc
<tt>`trunk/Identity/Themes/Motifs/TreeFlower'</tt> directory as example.
7e35dc
It is the trunk development line of TreeFlower artistic motif.
7e35dc
Artistic motifs are considered part of themes, which in turn are
7e35dc
considered part of CentOS corporate visual identity.
7e35dc

7e35dc

When building parent directory structures, you may find that reaching

7e35dc
an acceptable location may take some time, and as it uses to happen
7e35dc
most of time; once you've find it, that may be not a definite
7e35dc
solution.  There are many concepts that you need to play with, in
7e35dc
order to find a result that match the conceptual idea you try to
7e35dc
implement in the new directory location. To know which these concepts
7e35dc
are, split the location in words and read its documentation entry from
7e35dc
less specific to more specific.
7e35dc

7e35dc

For example, the <tt>`trunk/Identity/Themes/Motifs/TreeFlower'</tt>

7e35dc
location evolved through several months of contant work and there is
7e35dc
no certain it won't change in the future, even it fixes quite well the
7e35dc
concept we are trying to implement.  The concepts used in
7e35dc
<tt>`trunk/Identity/Themes/Distro/Motifs/TreeFlower'</tt> location are
7e35dc
described in the following commands, respectively:
7e35dc

7e35dc
centos-art manual --read=turnk/
7e35dc
centos-art manual --read=turnk/Identity/
7e35dc
centos-art manual --read=turnk/Identity/Themes/
7e35dc
centos-art manual --read=turnk/Identity/Themes/Motifs/
7e35dc
centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/
7e35dc
7e35dc

Other location concepts can be found similary as we did above, just

7e35dc
change the location we used above by the one you are trying to know
7e35dc
concepts for.
7e35dc

7e35dc
af3979
2dc146

3.53.3 Usage

4a9d2a
7e35dc
7e35dc
centos-art path --copy='SRC' --to='DST'
7e35dc
7e35dc

Copy <samp>`SRC'</samp> to <samp>`DST'</samp> and schedule <samp>`DST'</samp> for

7e35dc
addition (with history).  In this command, <tt>`SRC'</tt> and <tt>`DST'</tt>
7e35dc
are both working copy (WC) entries.
7e35dc

7e35dc
7e35dc
centos-art path --delete='SRC'
7e35dc
7e35dc

Delete <samp>`DST'</samp>. In order for this command to work the file or

7e35dc
directory you intend to delete should be under version control first.
7e35dc
In this command, <tt>`SRC'</tt> is a working copy (WC) entry.  
7e35dc

7e35dc
7e35dc
4a9d2a
2dc146
af3979
2dc146

3.53.4 See also

300762
7e35dc
af3979
3.48 trunk/Scripts/Bash  
7e35dc
af3979
3.49 trunk/Scripts/Bash/Functions  
7e35dc
7e35dc
4c79b5
4c79b5
4c79b5
af3979
[ < ]
af3979
[ > ]
4c79b5
   
300762
[ << ]
af3979
[ Up ]
af3979
[ >> ]
4c79b5
4c79b5

4c79b5
 <font size="-1">
bf28e1
  This document was generated on February, 27 2011 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

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