Blame Manual/repository-html/repository_74.html

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

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

632e8b
632e8b
06d106
632e8b

2.70.1 Goals

632e8b
06d106

This section exists to organize files related to path

06d106
functiontionality.  The path functionality standardizes
06d106
movement, syncronization, branching, tagging, and general file
06d106
maintainance inside the repository. 
632e8b

632e8b
06d106
632e8b

2.70.2 Description

632e8b
06d106

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

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

9bfd15
06d106
06d106

2.70.2.1 Repository layout

9bfd15
06d106

The repository layout describes organization of files and directories

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

06d106

As convenction, inside CentOS Artwork Repository, we organize files

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

06d106

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

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

06d106

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

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

06d106

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

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

06d106

The CentOS Artwork Repository layout is firmly grounded on a

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

9bfd15
06d106
06d106

2.70.2.2 Repository name convenctions

9bfd15
06d106

Repository name convenctions help us to maintain consistency of names

06d106
inside the repository.
06d106

06d106

Repository name convenctions are applied to files and directories

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

06d106

Repository name convenctions are implemented inside the

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

9bfd15
06d106
06d106

2.70.2.3 Repository work flow

9bfd15
06d106

Repository work flow describes the steps and time intervals used to

06d106
produce CentOS corporate visual identity inside CentOS Artwork
06d106
Repository.  
06d106

06d106

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

06d106
cycle. 
06d106

06d106

Initially, we start working themes on their trunk development line

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

06d106

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

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

06d106

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

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

06d106

Both branches and tags, inside CentOS Artwork Repository, use

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

06d106
Convenction

Convenction

Do not freeze trunk development lines using tags

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

9bfd15
06d106

The trunk development line may introduce problems we cannot see

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

06d106

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

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

06d106

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

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

06d106

Before releasing a new major release of CentOS distribution we create

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

9bfd15
06d106
06d106

2.70.2.4 Parallel directories

9bfd15
06d106

Inside CentOS Artwork Repository, parallel directories are simple

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

06d106

Parallel directories take their structure from one unique parent

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

06d106

In some circumstances, parallel directories may be created removing

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

06d106

Another example of parallel directory is the documentation structure

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

06d106

Othertimes, parallel directories may add uncommon information to their

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

06d106

When one parent directory changes, all their related parallel

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

632e8b
06d106
06d106

2.70.2.5 Syncronizing path information

9bfd15
06d106

Parallel directories are very useful to keep repository organized but

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

06d106

In such cases, functionalities like manual may confuse

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

06d106

In the specific case of documentation (the manual

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

06d106

There is no immediate way for manual, and similar

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

06d106
Warning

Warning

There is not support for URL reference inside

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

632e8b
06d106

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

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

06d106

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

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

632e8b
06d106
06d106

2.70.2.6 What is the right place to store it?

632e8b
06d106

Occasionly, you may find that new corporate visual identity components

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

06d106

The CentOS Community different free support vains (see:

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

06d106

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

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

06d106

When building parent directory structures, you may find that reaching

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

06d106

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

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

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

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

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

06d106
06d106
06d106

2.70.3 Usage

06d106
06d106
06d106
centos-art path --copy='SRC' --to='DST'
9bfd15
06d106

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

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

9bfd15
06d106
centos-art path --delete='SRC'
9bfd15
06d106

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

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

9bfd15
9bfd15
632e8b
9bfd15
06d106
632e8b

2.70.4 See also

632e8b
632e8b
06d106
2.62 The <tt>`trunk/Scripts/Bash'</tt> Directory  
632e8b
632e8b
632e8b
632e8b
632e8b
06d106
[ < ]
06d106
[ > ]
632e8b
   
632e8b
[ << ]
06d106
[ Up ]
06d106
[ >> ]
632e8b
632e8b

632e8b
 <font size="-1">
06d106
  This document was generated on March, 10 2011 using texi2html 1.76.
632e8b
 </font>
632e8b
 
632e8b
632e8b

632e8b
</body>
632e8b
</html>