Blame Manual/repository-html/repository_58.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>
b130a0
<title>CentOS Artwork Repository: 1.57 The trunk/Scripts/Bash/Cli/Functions/Path Directory</title>
ee1f37
b130a0
<meta name="description" content="CentOS Artwork Repository: 1.57 The trunk/Scripts/Bash/Cli/Functions/Path Directory">
b130a0
<meta name="keywords" content="CentOS Artwork Repository: 1.57 The trunk/Scripts/Bash/Cli/Functions/Path Directory">
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
b130a0
[ < ]
b130a0
[ > ]
ee1f37
   
aaf678
[ << ]
aaf678
[ Up ]
b130a0
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
56a476
[Top]
56a476
[Contents]
b130a0
[Index]
56a476
[ ? ]
ee1f37
b130a0
b130a0
b130a0

1.57 The <tt>`trunk/Scripts/Bash/Cli/Functions/Path'</tt> Directory

b130a0
b130a0
b130a0
b130a0

1.57.1 Goals

b130a0
b130a0

This section exists to organize files related to path

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

b130a0
b130a0
b130a0

1.57.2 Description

b130a0
b130a0

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

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

b130a0
b130a0
b130a0

1.57.2.1 Repository layout

b130a0
b130a0

The repository layout describes organization of files and directories

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

b130a0

As convenction, inside CentOS Artwork Repository, we organize files

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

b130a0

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

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

b130a0

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

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

b130a0

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

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

b130a0

The CentOS Artwork Repository layout is firmly grounded on a

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

b130a0
b130a0
b130a0

1.57.2.2 Repository name convenctions

b130a0
b130a0

Repository name convenctions help us to maintain consistency of names

b130a0
inside the repository.
b130a0

b130a0

Repository name convenctions are applied to files and directories

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

b130a0

Repository name convenctions are implemented inside the

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

b130a0
b130a0
b130a0

1.57.2.3 Repository work flow

b130a0
b130a0

Repository work flow describes the steps and time intervals used to

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

b130a0

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

b130a0
cycle. 
b130a0

b130a0

Initially, we start working themes on their trunk development line

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

b130a0

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

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

b130a0

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

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

b130a0

Both branches and tags, inside CentOS Artwork Repository, use

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

b130a0
Convenction

Convenction

Do not freeze trunk development lines using tags

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

aaf678
b130a0

The trunk development line may introduce problems we cannot see

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

b130a0

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

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

b130a0

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

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

b130a0

Before releasing a new major release of CentOS distribution we create

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

aaf678
b130a0
b130a0

1.57.2.4 Parallel directories

b130a0
b130a0

Inside CentOS Artwork Repository, parallel directories are simple

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

b130a0

Parallel directories take their structure from one unique parent

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

b130a0

In some circumstances, parallel directories may be created removing

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

b130a0

Another example of parallel directory is the documentation structure

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

b130a0

Othertimes, parallel directories may add uncommon information to their

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

b130a0

When one parent directory changes, all their related parallel

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

aaf678
b130a0
b130a0

1.57.2.5 Syncronizing path information

b130a0
b130a0

Parallel directories are very useful to keep repository organized but

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

b130a0

In such cases, functionalities like manual may confuse

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

b130a0

In the specific case of documentation (the manual

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

b130a0

There is no immediate way for manual, and similar

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

b130a0
Warning

Warning

There is not support for URL reference inside

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

010b2d
b130a0

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

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

b130a0

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

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

aaf678
b130a0
b130a0

1.57.2.6 What is the right place to store it?

b130a0
b130a0

Occasionly, you may find that new corporate visual identity components

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

b130a0

The CentOS Community different free support vains (see:

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

b130a0

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

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

b130a0

When building parent directory structures, you may find that reaching

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

b130a0

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

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

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

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

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

aaf678
b130a0
b130a0

1.57.3 Usage

aaf678
010b2d
b130a0
centos-art path --copy='SRC' --to='DST'
010b2d
b130a0

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

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

010b2d
b130a0
centos-art path --delete='SRC'
aaf678
b130a0

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

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

b130a0
010b2d
010b2d
010b2d
b130a0
b130a0

1.57.4 See also

010b2d
b130a0
b130a0
1.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
b130a0
b130a0
ee1f37
ee1f37
ee1f37
b130a0
[ < ]
b130a0
[ > ]
ee1f37
   
aaf678
[ << ]
b130a0
[ Up ]
b130a0
[ >> ]
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>