Blame Manuals/Repository/repository-html/repository_55.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>
1023f4
<title>CentOS Artwork Repository: 3.52 trunk/Scripts/Bash/Functions/Path</title>
4c79b5
1023f4
<meta name="description" content="CentOS Artwork Repository: 3.52 trunk/Scripts/Bash/Functions/Path">
1023f4
<meta name="keywords" content="CentOS Artwork Repository: 3.52 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
d11e55
[ < ]
d11e55
[ > ]
4c79b5
   
4c79b5
[ << ]
300762
[ Up ]
1023f4
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
1023f4
[Index]
4c79b5
[ ? ]
4c79b5
1023f4
d11e55
1023f4

3.52 trunk/Scripts/Bash/Functions/Path

b0644c
b0644c
d11e55
e37211

3.52.1 Goals

b0644c
1023f4

This section exists to organize files related to path

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

035049
d11e55
e37211

3.52.2 Description

b0644c
1023f4

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

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

c12cdc
42563b
1023f4

3.52.2.1 Repository layout

1023f4
1023f4

The repository layout describes organization of files and directories

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

1023f4

As convenction, inside CentOS Artwork Repository, we organize files

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

1023f4

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

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

1023f4

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

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

1023f4

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

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

1023f4

The CentOS Artwork Repository layout is firmly grounded on a

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

1023f4
1023f4
1023f4

3.52.2.2 Repository name convenctions

1023f4
1023f4

Repository name convenctions help us to maintain consistency of names

1023f4
inside the repository.
1023f4

1023f4

Repository name convenctions are applied to files and directories

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

1023f4

Repository name convenctions are implemented inside the

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

1023f4
1023f4
1023f4

3.52.2.3 Repository work flow

1023f4
1023f4

Repository work flow describes the steps and time intervals used to

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

1023f4

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

1023f4
cycle. 
1023f4

1023f4

Initially, we start working themes on their trunk development line

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

1023f4

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

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

1023f4

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

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

1023f4

Both branches and tags, inside CentOS Artwork Repository, use

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

1023f4
Convenction

Convenction

Do not freeze trunk development lines using tags

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

1023f4
1023f4

The trunk development line may introduce problems we cannot see

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

1023f4

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

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

1023f4

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

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

1023f4

Before releasing a new major release of CentOS distribution we create

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

1023f4
1023f4
1023f4

3.52.2.4 Parallel directories

1023f4
1023f4

Inside CentOS Artwork Repository, parallel directories are simple

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

1023f4

Parallel directories take their structure from one unique parent

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

1023f4

In some circumstances, parallel directories may be created removing

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

1023f4

Another example of parallel directory is the documentation structure

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

1023f4

Othertimes, parallel directories may add uncommon information to their

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

1023f4

When one parent directory changes, all their related parallel

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

1023f4
1023f4
1023f4

3.52.2.5 Syncronizing path information

1023f4
1023f4

Parallel directories are very useful to keep repository organized but

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

1023f4

In such cases, functionalities like manual may confuse

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

1023f4

In the specific case of documentation (the manual

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

1023f4

There is no immediate way for manual, and similar

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

1023f4
Warning

Warning

There is not support for URL reference inside

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

1023f4
1023f4

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

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

1023f4

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

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

1023f4
1023f4
1023f4

3.52.2.6 What is the right place to store it?

1023f4
1023f4

Occasionly, you may find that new corporate visual identity components

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

1023f4

The CentOS Community different free support vains (see:

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

1023f4

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

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

1023f4

When building parent directory structures, you may find that reaching

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

1023f4

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

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

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

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

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

1023f4
1023f4
4a9d2a

3.52.3 Usage

4a9d2a
70ef27
1023f4
centos-art path --copy='SRC' --to='DST'
1023f4
1023f4

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

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

1023f4
1023f4
centos-art path --delete='SRC'
1023f4
1023f4

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

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

1023f4
70ef27
4a9d2a
ec5f63
1023f4
008ee0

3.52.4 See also

bc3531
1023f4
1023f4
3.47 trunk/Scripts/Bash  
1023f4
1023f4
3.48 trunk/Scripts/Bash/Functions  
1023f4
1023f4
4c79b5
2c8180
4c79b5
1023f4
[ < ]
1023f4
[ > ]
4c79b5
   
4c79b5
[ << ]
d11e55
[ Up ]
1023f4
[ >> ]
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>