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

4c79b5
4c79b5
<html>
6414c4
09d4f2
6414c4
Copyright C 2009, 2010, 2011  Alain Reguera Delgado
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
-->
92fb7f
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>
4224f4
<title>The CentOS Artwork Repository: 3.41 trunk/Scripts/Bash/Functions/Path</title>
4c79b5
4224f4
<meta name="description" content="The CentOS Artwork Repository: 3.41 trunk/Scripts/Bash/Functions/Path">
4224f4
<meta name="keywords" content="The CentOS Artwork Repository: 3.41 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
01b527
[ < ]
01b527
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
4224f4
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
4224f4
[Index]
4c79b5
[ ? ]
4c79b5
4224f4
01b527
4224f4

3.41 trunk/Scripts/Bash/Functions/Path

b0644c
b0644c
01b527
e37211

3.41.1 Goals

e37211
4224f4

This section exists to organize files related to path

67c914
functiontionality.  The path functionality standardizes
67c914
movement, syncronization, branching, tagging, and general file
67c914
maintainance inside the repository. 
4224f4

63f275
01b527
e37211

3.41.2 Description

e37211
4224f4

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

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

3207df
280c77
4224f4

3.41.2.1 Repository layout

3207df
4224f4

The repository layout describes organization of files and directories

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

4224f4

As convenction, inside CentOS Artwork Repository, we organize files

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

4224f4
4224f4

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-6

3207df
4224f4

Figure 3.15: The CentOS Artwork Repository layout.

4224f4
4224f4

4224f4

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

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

4224f4

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

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

4224f4

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

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

4224f4

The CentOS Artwork Repository layout is firmly grounded on a

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

3207df
280c77
4224f4

3.41.2.2 Repository name convenctions

4224f4
4224f4

Repository name convenctions help us to maintain consistency of names

4224f4
inside the repository.
4224f4

4224f4

Repository name convenctions are applied to files and directories

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

4224f4

Repository name convenctions are implemented inside the

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

4224f4
4224f4
4224f4

3.41.2.3 Repository work flow

4224f4
4224f4

Repository work flow describes the steps and time intervals used to

4224f4
produce CentOS corporate visual identity inside CentOS Artwork
4224f4
Repository.  
4224f4

4224f4

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

4224f4
cycle. 
4224f4

4224f4

Initially, we start working themes on their trunk development line

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

4224f4

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

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

4224f4

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

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

4224f4

Both branches and tags, inside CentOS Artwork Repository, use

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

4224f4
4224f4

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-1

4224f4
4224f4

Figure 3.16: Name convention for tags and branches creation.

4224f4
4224f4

4224f4
Convenction

Convenction

Do not freeze trunk development lines using tags

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

4224f4
4224f4

The trunk development line may introduce problems we cannot see

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

4224f4

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

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

4224f4

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

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

4224f4

Before releasing a new major release of CentOS distribution we create

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

4224f4
4224f4
4224f4

3.41.2.4 Parallel directories

4224f4
4224f4

Inside CentOS Artwork Repository, parallel directories are simple

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

4224f4

Parallel directories take their structure from one unique parent

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

4224f4

In some circumstances, parallel directories may be created removing

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

4224f4
4224f4

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-3

4224f4
4224f4

Figure 3.17: Parallel directories removing uncommon information.

4224f4
4224f4

10d59d

Another example of parallel directory is the documentation structure

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

4224f4

Othertimes, parallel directories may add uncommon information to their

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

4224f4
4224f4

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-4

4224f4
4224f4

Figure 3.18: Parallel directories adding uncommon information.

4224f4
4224f4

4224f4

When one parent directory changes, all their related parallel

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

4224f4
4224f4

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-5

4224f4
4224f4

Figure 3.19: Wrong construction of parallel directories.

4224f4
4224f4

4224f4
4224f4
4224f4

3.41.2.5 Syncronizing path information

4224f4
10d59d

Parallel directories are very useful to keep repository organized but

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

10d59d

In such cases, functionalities like manual may confuse

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

4224f4

In the specific case of documentation (the manual

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

10d59d

There is no immediate way for manual, and similar

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

10d59d
Warning

Warning

There is not support for URL reference inside

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

4224f4
4224f4

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

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

10d59d

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

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

4224f4
4224f4
4224f4

3.41.2.6 What is the right place to store it?

4224f4
4224f4

Occasionly, you may find that new corporate visual identity components

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

4224f4

The CentOS Community different free support vains (see:

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

4224f4

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

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

4224f4

When building parent directory structures, you may find that reaching

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

4224f4

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

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

4224f4
centos-art manual --read=turnk/
4224f4
centos-art manual --read=turnk/Identity/
4224f4
centos-art manual --read=turnk/Identity/Themes/
4224f4
centos-art manual --read=turnk/Identity/Themes/Motifs/
4224f4
centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/
4224f4
4224f4

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

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

4224f4
4224f4
4224f4

3.41.3 Usage

4224f4
4224f4
10d59d
centos-art path --copy='SRC' --to='DST'
10d59d
10d59d

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

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

4224f4
4224f4
centos-art path --delete='SRC'
10d59d
10d59d

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

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

4224f4
4224f4
4224f4
4224f4
4224f4
54264c

3.41.4 See also

4c79b5
4224f4
4224f4
3.36 trunk/Scripts/Bash  
4224f4
4224f4
3.37 trunk/Scripts/Bash/Functions  
4224f4
4224f4
4c79b5
4c79b5
4c79b5
4224f4
[ < ]
4224f4
[ > ]
4c79b5
   
4c79b5
[ << ]
01b527
[ Up ]
4224f4
[ >> ]
4c79b5
4c79b5

4c79b5
 <font size="-1">
92fb7f
  This document was generated on January, 5 2011 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

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