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
-->
acd47b
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>
c2a1bc
<title>CentOS Artwork Repository: 3.53 trunk/Scripts/Bash/Functions/Path</title>
4c79b5
c2a1bc
<meta name="description" content="CentOS Artwork Repository: 3.53 trunk/Scripts/Bash/Functions/Path">
c2a1bc
<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
2dc146
[ < ]
2dc146
[ > ]
4c79b5
   
300762
[ << ]
300762
[ Up ]
c2a1bc
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
c2a1bc
[Index]
4c79b5
[ ? ]
4c79b5
c2a1bc
2dc146
c2a1bc

3.53 trunk/Scripts/Bash/Functions/Path

2dc146
2dc146
2dc146
2dc146

3.53.1 Goals

2dc146
c2a1bc

This section exists to organize files related to path

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

2dc146
2dc146
2dc146

3.53.2 Description

2dc146
c2a1bc

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

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

2b5e61
7fa1fb
c2a1bc

3.53.2.1 Repository layout

c2a1bc
c2a1bc

The repository layout describes organization of files and directories

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

c2a1bc

As convenction, inside CentOS Artwork Repository, we organize files

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

c2a1bc

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

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

c2a1bc

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

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

c2a1bc

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

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

c2a1bc

The CentOS Artwork Repository layout is firmly grounded on a

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

c2a1bc
c2a1bc
c2a1bc

3.53.2.2 Repository name convenctions

c2a1bc
c2a1bc

Repository name convenctions help us to maintain consistency of names

c2a1bc
inside the repository.
c2a1bc

c2a1bc

Repository name convenctions are applied to files and directories

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

c2a1bc

Repository name convenctions are implemented inside the

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

c2a1bc
c2a1bc
c2a1bc

3.53.2.3 Repository work flow

c2a1bc
c2a1bc

Repository work flow describes the steps and time intervals used to

c2a1bc
produce CentOS corporate visual identity inside CentOS Artwork
c2a1bc
Repository.  
c2a1bc

c2a1bc

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

c2a1bc
cycle. 
c2a1bc

c2a1bc

Initially, we start working themes on their trunk development line

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

c2a1bc

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

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

c2a1bc

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

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

c2a1bc

Both branches and tags, inside CentOS Artwork Repository, use

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

c2a1bc
Convenction

Convenction

Do not freeze trunk development lines using tags

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

c2a1bc
c2a1bc

The trunk development line may introduce problems we cannot see

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

c2a1bc

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

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

c2a1bc

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

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

c2a1bc

Before releasing a new major release of CentOS distribution we create

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

c2a1bc
c2a1bc
c2a1bc

3.53.2.4 Parallel directories

c2a1bc
c2a1bc

Inside CentOS Artwork Repository, parallel directories are simple

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

c2a1bc

Parallel directories take their structure from one unique parent

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

c2a1bc

In some circumstances, parallel directories may be created removing

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

c2a1bc

Another example of parallel directory is the documentation structure

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

c2a1bc

Othertimes, parallel directories may add uncommon information to their

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

c2a1bc

When one parent directory changes, all their related parallel

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

c2a1bc
c2a1bc
c2a1bc

3.53.2.5 Syncronizing path information

c2a1bc
c2a1bc

Parallel directories are very useful to keep repository organized but

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

c2a1bc

In such cases, functionalities like manual may confuse

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

c2a1bc

In the specific case of documentation (the manual

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

c2a1bc

There is no immediate way for manual, and similar

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

c2a1bc
Warning

Warning

There is not support for URL reference inside

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

c2a1bc
c2a1bc

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

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

c2a1bc

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

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

c2a1bc
c2a1bc
c2a1bc

3.53.2.6 What is the right place to store it?

c2a1bc
c2a1bc

Occasionly, you may find that new corporate visual identity components

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

c2a1bc

The CentOS Community different free support vains (see:

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

c2a1bc

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

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

c2a1bc

When building parent directory structures, you may find that reaching

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

c2a1bc

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

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

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

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

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

c2a1bc
c2a1bc
2dc146

3.53.3 Usage

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

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

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

c2a1bc
c2a1bc
centos-art path --delete='SRC'
c2a1bc
c2a1bc

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

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

c2a1bc
c2a1bc
4a9d2a
2dc146
c2a1bc
2dc146

3.53.4 See also

300762
c2a1bc
c2a1bc
3.48 trunk/Scripts/Bash  
c2a1bc
c2a1bc
3.49 trunk/Scripts/Bash/Functions  
c2a1bc
c2a1bc
4c79b5
4c79b5
4c79b5
c2a1bc
[ < ]
c2a1bc
[ > ]
4c79b5
   
300762
[ << ]
2dc146
[ Up ]
c2a1bc
[ >> ]
4c79b5
4c79b5

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

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