• ArchipelUserStories

• VersionControlWishlist (collections of things I'd like to see in VCS)

• ArchipelAdvancedUsage

• File, an ubiquitous utility that can guess a file MIME-type and encoding.

Current status update : as this wiki page was linked from wikipedia, I got some attention on Archipel. The project has been stalled for a year now, but I would be really interested in resuming it. Latest sources can be accessed from http://software.type-z.org/downloads, and if there is somebody interested in working on it with me, I will resume the project.

• ftp://ftp.astron.com/pub/file/ File, an ubiquitous utility that can guess a file MIME-type and encoding. http://www.pldaniels.com/filetype/ Filetype is a less-featured and less-mature (and I guess deprecated) alternative.http://luukurkkuun.com/gay-gang-bang-college-gang.html .http://orgy-sex.selectedsex.com/anal-gang-bang-crew-gang.html .http://gang-bang.sex4dollar.com/wife-gang-bang-gang-milf.html .http://house9999.com/orgy-sex.html .http://beitshalomadelaide.com/wife-gang-bang-gang-milf.html .

Intermediate usage

Annotating files and directories

 archipel annotate [file|directories] [name] [value]

Setting up filters

 archipel filter create [name]

or

 archipel filter edit [name]

or

 archipel filter remove [name]

or

 archipel filter list

Advanced usage

Creating branches

Merging branches

Subscribing to a branch

Organising branches

References

ArchipelDeltas, presents a list of current deltas available in Archipel.

Here is a short list of papers which participated in the development of Archipel :

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel
• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.
• Ragnarok?, an architecture-based software configuration management system. Ragnarok promotes the notion of high level deltas, and offers a different perspective of what SCM can be.

Here are some articles/pages of interest:

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel. It also references an http://www.linuxjournal.com/article.php?sid=1250 old article on RCS, which is amusing and let you understand what changed since then.
• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

Here is a list of related software:

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.
• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive.
• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.

Here are the software used by Archipel:

• ArchipelQuickStart (a user guide and reference manual to quicly start using Archipel)

• ArchipelPrinciples (sums up the basic principle on which Arhicpel is built)
• ArchipelTerminology (sums up the specific terms used in Archipel )
• ArchitpelQuickStart? (a user guide and reference manual to quicly start using Archipel)

Intermediate usage

Annotating files and directories

 archipel annotate [file|directories] [name] [value]

Setting up filters

 archipel filter create [name]

or

 archipel filter edit [name]

or

 archipel filter remove [name]

or

 archipel filter list

Advanced usage

Creating branches

Merging branches

Subscribing to a branch

Organising branches

References

ArchipelDeltas, presents a list of current deltas available in Archipel.

Here is a short list of papers which participated in the development of Archipel :

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel
• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.
• Ragnarok?, an architecture-based software configuration management system. Ragnarok promotes the notion of high level deltas, and offers a different perspective of what SCM can be.

Here are some articles/pages of interest:

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel. It also references an http://www.linuxjournal.com/article.php?sid=1250 old article on RCS, which is amusing and let you understand what changed since then.
• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

Here is a list of related software:

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.
• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive.
• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.

Here are the software used by Archipel:

• ArchitpelQuickStart?

Archipel Software Configuration Management

Related documents:

• ArchipelPrinciples
• ArchipelDeltas

To sum up Archipel goals:

• Provide a simple, powerful, modern revision control system that fits open-source distributed development
• Provide a flexible framework on which advanced software configuration management can be built.

1. General document conventions

This sections presents Archipel command-line usage. Every example is given using a relatively simple syntax:

 archipel [command] [arguments]

Where something between @ and @ is a value of the given type. This "something" can be assigned a cardinality. For instance,

 archipel status [file|directory]+

indicates that the status command of Archipel can take 1 to many argumens of type file or directory, which are the two basic types (with litteral, meaning a text string) that Archipel commands can take.

2. Quick start

This section will guide you through the steps involved in a basic usage of Archipel. You will learn how to create and setup an Archipel project, how to track changes, commit changes, checkout particular versions and distribute your changes to other developers.

Whenever you encounter a term that might be difficult to understand, you can refere to the ArchipelTerminology.

2.1 Creating a project

Creating a new project in archipel is dead simple, you just have to cd to the directory you want to put under version control, and type

 archipel create [name] 

where name is your project name. Typing archipel create MyProject? will create a MyProject?.archipel file in the current directory.

Alternatively, if you do not want to put the current directory under control, you can specify explicitely another directory with

 achipel create [name] [directory]

where directory is the path to the directory (your project directory) that you want to put under version control. In this case, the project file will also be created in the designated directory.

Once the project file is created, you can issue any other archipel command as long as you type them in the directory containing the project file, or in any of its subdirectories.

2.2 Assigning a repository

When you create a new Archipel project, the project needs a place to store the versionning information. This place is caleld the repository.

A repository is simply a directory on your local filesystem that holds all the information needed to restore previous states of your project.

By default, the project repository is located in your project root directory, and is name MyProject?.repostory, where you replace MyProject? by your actual project name. If the ARCHIPEL_REPOSITORY environment variable is defined, the repository will instead be located at the value of this variable. Note that a directory can be shared by multiple projects.

To determine the project that was assigned to your project, you can type the following command:

 archipel repository status

If you want to specify another location for your repository, you can type the following command:

 archipel repository set [location]

which will set the repository to be the given location. If the given repository does not exist, it will be created, otherwise the existing repository will be used. Once that a project was created an assigned a repository, you can put files and directories under version control.

Note that you can change the repository location at any time during your project lifecycle. In some cases, Archipel will move or copy information from your old repository to the new one. Also, it you can note that repositories are not created until first commit, so that changing your repository location will not spoil your filesystem at project creation.

2.3 Putting files and directories under version control

By default, Archipel does not track any file in your newly created project. You have to indicate which files you want it to track, using the track command

 archipel track [file|directory]+

Conversly, if you do not want to track a file or a directory anymore, you can use the untrack command

 archipel untrack [file|directory]+

When you untrack a file or a directory, you can still re-track it later and keep its history. In most cases, this will be automatically made by archipel.

2.4 Querying projet status

The current project or a particular directory status can be queried by the following command :

 archipel status [file|directory]*

which gives the status of all the files in the current project, or you can also type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their tracking status:

From Archipel's perspective, version control is simply a generalization of an undo mechanism, where deltas are simply serializable undoable commands. In this respect, Archipel also aims at providing a flexible framework for building specific version models.

• Repository is stored in a queryable RDF database
• Deltas (changes) are represented in an OO way, which allows user to create new deltas, specific to their version model.

To sum up Archipel goals:

• Provide a simple, powerful, modern revision control system that fits open-source distributed development
• Provide a flexible framework on which advanced software configuration management can be built.

More details can be found in FromRCStoSCM?.

1. General document conventions

This sections presents Archipel command-line usage. Every example is given using a relatively simple syntax:

 archipel [command] [arguments]

Where something between @ and @ is a value of the given type. This "something" can be assigned a cardinality. For instance,

 archipel status [file|directory]+

indicates that the status command of Archipel can take 1 to many argumens of type file or directory, which are the two basic types (with litteral, meaning a text string) that Archipel commands can take.

2. Quick start

This section will guide you through the steps involved in a basic usage of Archipel. You will learn how to create and setup an Archipel project, how to track changes, commit changes, checkout particular versions and distribute your changes to other developers.

Whenever you encounter a term that might be difficult to understand, you can refere to the ArchipelTerminology.

2.1 Creating a project

Creating a new project in archipel is dead simple, you just have to cd to the directory you want to put under version control, and type

 archipel create [name] 

where name is your project name. Typing archipel create MyProject? will create a MyProject?.archipel file in the current directory.

Alternatively, if you do not want to put the current directory under control, you can specify explicitely another directory with

 achipel create [name] [directory]

where directory is the path to the directory (your project directory) that you want to put under version control. In this case, the project file will also be created in the designated directory.

Once the project file is created, you can issue any other archipel command as long as you type them in the directory containing the project file, or in any of its subdirectories.

2.2 Assigning a repository

When you create a new Archipel project, the project needs a place to store the versionning information. This place is caleld the repository.

A repository is simply a directory on your local filesystem that holds all the information needed to restore previous states of your project.

By default, the project repository is located in your project root directory, and is name MyProject?.repostory, where you replace MyProject? by your actual project name. If the ARCHIPEL_REPOSITORY environment variable is defined, the repository will instead be located at the value of this variable. Note that a directory can be shared by multiple projects.

To determine the project that was assigned to your project, you can type the following command:

 archipel repository status

If you want to specify another location for your repository, you can type the following command:

 archipel repository set [location]

which will set the repository to be the given location. If the given repository does not exist, it will be created, otherwise the existing repository will be used. Once that a project was created an assigned a repository, you can put files and directories under version control.

Note that you can change the repository location at any time during your project lifecycle. In some cases, Archipel will move or copy information from your old repository to the new one. Also, it you can note that repositories are not created until first commit, so that changing your repository location will not spoil your filesystem at project creation.

2.3 Putting files and directories under version control

By default, Archipel does not track any file in your newly created project. You have to indicate which files you want it to track, using the track command

 archipel track [file|directory]+

Conversly, if you do not want to track a file or a directory anymore, you can use the untrack command

 archipel untrack [file|directory]+

When you untrack a file or a directory, you can still re-track it later and keep its history. In most cases, this will be automatically made by archipel.

2.4 Querying projet status

The current project or a particular directory status can be queried by the following command :

 archipel status [file|directory]*

which gives the status of all the files in the current project, or you can also type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their tracking status:

• + for a file which is newly tracked
• - for a file that will not be tracked anymore
• for a file that is already tracked and will continue to be
• ~ for untracked files (they are not shown by default)

and content status:

• C for created file
• Cp for copied file
• Mv for moved file
• Rm for removed file
• M for modified file
• Nothing for an unmodified file

Created, copied and moved file all belong to files that are not found in the previous revision of the controlled project. These files were all created, copied or moved since last commit.

Removed files are files that cannot be found anymore in the current project, but were present when the project was last commited.

Modified and unmodified files are both present in the previous and current revisions of the project.

Status also allows:

• To include directories in the status (by default only files are shown)
• To decide which sets (new, changed, moved, etc. are considered as sets) have to be shown
• To use a specific filter to hide or show specific files or directories (like symlinks, or files ending with a specific suffix, etc.)

To get more information, you can type archipel help status.

2.5 Commiting changes

Once your project files are put under version control, you can commit changes that will represent the current state of your project (or at least, parts of it).

To commit changes, simply use the command

 archipel commit

which will commit all the changes made to the current project. Your default text editor (from the EDITOR environment variable) will then open, summarizing the changes and asking you to fill in a description. You can also commit changes locally with the following command

 archipel commit .

which will only commit changes made to the current directory. You can also specify any location

 archipel commit [location]

which will commit changes made only to the given location.

Getting project information

Once you commit changes to the repository, you might want to be able to refer to these changes (or change set) as a whole. To do so, you can use the head command:

 archipel head

which will return you the identifier (a 40 character string) identifying the set of changes you've just commited. This identifier also refers to the specific version of your project. When you will want to later retrieve this version (aka. check out), you will need this identifier.

Checking out versions

Publishing a release

Intermediate usage

Annotating files and directories

 archipel annotate [file|directories] [name] [value]

Setting up filters

 archipel filter create [name]

or

 archipel filter edit [name]

or

 archipel filter remove [name]

or

 archipel filter list

Advanced usage

Creating branches

Merging branches

Subscribing to a branch

Organising branches

References

ArchipelDeltas, presents a list of current deltas available in Archipel.

Here is a short list of papers which participated in the development of Archipel :

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel
• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.
• Ragnarok?, an architecture-based software configuration management system. Ragnarok promotes the notion of high level deltas, and offers a different perspective of what SCM can be.

Here are some articles/pages of interest:

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel. It also references an http://www.linuxjournal.com/article.php?sid=1250 old article on RCS, which is amusing and let you understand what changed since then.
• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

Here is a list of related software:

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.
• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive.
• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.

Here are the software used by Archipel:

where directory is the path to the directory (your project directory) that you want to put under version control. In this case, the project file will also be created in the designated directory.

Note that you can change the repository location at any time during your project lifecycle. In some cases, Archipel will move or copy information from your old repository to the new one. Also, it you can note that repositories are not created until first commit, so that changing your repository location will not spoil your filesystem at project creation.

When you create a new Archipel project, the project needs a place to store the versionning information. This place is caleld the repository.

By default, the project repository is located in your project root directory, and is name MyProject?.repostory, where you replace MyProject? by your actual project name. If the ARCHIPEL_REPOSITORY environment variable is defined, the repository will instead be located at the value of this variable. Note that a directory can be shared by multiple projects.

To determine the project that was assigned to your project, you can type the following command:

If you want to specify another location for your repository, you can type the following command:

Note that you can change the repository location at any time during your project lifecycle. In some cases, Archipel will move or copy information from your old repository to the new one.

This section will guide you through the steps involved in a basic usage of Archipel. You will learn how to create and setup an Archipel project, how to track changes, commit changes, checkout particular versions and distribute your changes to other developers.

Whenever you encounter a term that might be difficult to understand, you can refere to the ArchipelTerminology.

2.1 Creating a project

Creating a new project in archipel is dead simple, you just have to cd to the directory you want to put under version control, and type

 archipel create [name] 

where name is your project name. Typing archipel create MyProject? will create a MyProject?.archipel file in the current directory.

Alternatively, if you do not want to put the current directory under control, you can specify explicitely another directory with

 achipel create [name] [directory]

where directory is the path where the Archipel project file will be created.

Once the project file is created, you can issue any other archipel command as long as you type them in the directory containing the project file, or in any of its subdirectories.

2.2 Assigning a repository

When you create a new Archipel project, it has to be associated to a repository that will store the evolution of your project files.

A repository is simply a directory on your local filesystem that holds all the information needed to restore previous states of your project.

By default, a project is not associated to any repository. If the ARCHIPEL_REPOSITORY environment variable is defined, the content of this variable is used to indicate the location of the repository to use for newly created projects.

To determine if your project has already a repository, you can use the command:

 archipel repository status

this tells you if the current project was assigned a repository, in which case the repository location is returned. If the project has no directory, you can assign one by using the command

 archipel repository set [location]

which will set the repository to be the given location. If the given repository does not exist, it will be created, otherwise the existing repository will be used. Once that a project was created an assigned a repository, you can put files and directories under version control.

2.3 Putting files and directories under version control

By default, Archipel does not track any file in your newly created project. You have to indicate which files you want it to track, using the track command

 archipel track [file|directory]+

Conversly, if you do not want to track a file or a directory anymore, you can use the untrack command

 archipel untrack [file|directory]+

When you untrack a file or a directory, you can still re-track it later and keep its history. In most cases, this will be automatically made by archipel.

2.4 Querying projet status

The current project or a particular directory status can be queried by the following command :

 archipel status [file|directory]*

which gives the status of all the files in the current project, or you can also type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their tracking status:

1. General document conventions

2. Quick start

2.1 Creating a project

2.2 Assigning a repository

this tells you if the current project was assigned a repository, in which case the repository location is returned. If the project has no directory, you can assign one by using the command

which will set the repository to be the given location. If the given repository does not exist, it will be created, otherwise the existing repository will be used. Once that a project was created an assigned a repository, you can put files and directories under version control.

2.3 Putting files and directories under version control

2.4 Querying projet status

2.5 Commiting changes

which will commit all the changes made to the current project. Your default text editor (from the EDITOR environment variable) will then open, summarizing the changes and asking you to fill in a description. You can also commit changes locally with the following command

which will commit changes made only to the given location.

Assigning a repository

When you create a new Archipel project, it has to be associated to a repository that will store the evolution of your project files.

A repository is simply a directory on your local filesystem that holds all the information needed to restore previous states of your project.

By default, a project is not associated to any repository. If the ARCHIPEL_REPOSITORY environment variable is defined, the content of this variable is used to indicate the location of the repository to use for newly created projects.

To determine if your project has already a repository, you can use the command:

 archipel repository status

this tells you if the current project was assigned a repository, in which case the repository location is returned.

If the project has no directory, you can assign one by using the command

 archipel repository set [location]

which will set the repository to be the given location. If the given repository does not exist, it will be created, otherwise the existing repository will be used.

Once that a project was created an assigned a repository, you can put files and directories under version control.

Putting files and directories under version control

By default, Archipel does not track any file in your newly created project. You have to indicate which files you want it to track, using the track command

 archipel track [file|directory]+

Conversly, if you do not want to track a file or a directory anymore, you can use the untrack command

 archipel untrack [file|directory]+

When you untrack a file or a directory, you can still re-track it later and keep its history. In most cases, this will be automatically made by archipel.

Querying projet status

The current project or a particular directory status can be queried by the following command :

 archipel status [file|directory]*

which gives the status of all the files in the current project, or you can also type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their tracking status:

• + for a file which is newly tracked
• - for a file that will not be tracked anymore
• | for a file that is already tracked and will continue to be
• Nothing for untracked files (they are not shown by default)

and content status:

• C for created file
• Cp for copied file
• Mv for moved file
• Rm for removed file
• M for modified file
• Nothing for an unmodified file

Created, copied and moved file all belong to files that are not found in the previous revision of the controlled project. These files were all created, copied or moved since last commit.

Removed files are files that cannot be found anymore in the current project, but were present when the project was last commited.

Modified and unmodified files are both present in the previous and current revisions of the project.

Status also allows:

• To include directories in the status (by default only files are shown)
• To decide which sets (new, changed, moved, etc. are considered as sets) have to be shown
• To use a specific filter to hide or show specific files or directories (like symlinks, or files ending with a specific suffix, etc.)

To get more information, you can type archipel help status.

Commiting changes

Once your project files are put under version control, you can commit changes that will represent the current state of your project (or at least, parts of it).

To commit changes, simply use the command

 archipel commit

which will commit all the changes made to the current project. Your default text editor (from the EDITOR environment variable) will then open, summarizing the changes and asking you to fill in a description.

You can commit changes locally with the following command

 archipel commit .

which will only commit changes made to the current directory. You can also specify any location

 archipel commit [location]

which will commit changes made to the given location.

Checking out versions

Publishing a release

Intermediate usage

Annotating files and directories

 archipel annotate [file|directories] [name] [value]

Setting up filters

 archipel filter create [name]

or

 archipel filter edit [name]

or

 archipel filter remove [name]

or

 archipel filter list

Advanced usage

Creating branches

Merging branches

Subscribing to a branch

Organising branches

References

ArchipelDeltas, presents a list of current deltas available in Archipel.

Here is a short list of papers which participated in the development of Archipel :

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel
• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.

Here are some articles/pages of interest:

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel. It also references an http://www.linuxjournal.com/article.php?sid=1250 old article on RCS, which is amusing and let you understand what changed since then.
• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

Here is a list of related software:

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.
• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive.
• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.

Here are the software used by Archipel:

• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive.

The status command ouputs a list of files prefixed by their tracking status:

• + for a file which is newly tracked
• - for a file that will not be tracked anymore
• | for a file that is already tracked and will continue to be
• Nothing for untracked files (they are not shown by default)

and content status:

• C for created file
• Cp for copied file

• M for modified file
• Nothing for an unmodified file

Created, copied and moved file all belong to files that are not found in the previous revision of the controlled project. These files were all created, copied or moved since last commit.

Removed files are files that cannot be found anymore in the current project, but were present when the project was last commited.

Modified and unmodified files are both present in the previous and current revisions of the project.

Status also allows:

By default, Archipel does not track any file in your newly created project. You have to indicate which files you want it to track, using the track command

Conversly, if you do not want to track a file or a directory anymore, you can use the untrack command

When you untrack a file or a directory, you can still re-track it later and keep its history. In most cases, this will be automatically made by archipel.

Creating a new project in archipel is dead simple, you just have to cd to the directory you want to put under version control, and type

 archipel create [name] 

where name is your project name. Typing archipel create MyProject? will create a MyProject?.archipel file in the current directory.

Alternatively, if you do not want to put the current directory under control, you can specify explicitely another directory with

 achipel create [name] [directory]

where directory is the path where the Archipel project file will be created.

Once the project file is created, you can issue any other archipel command as long as you type them in the directory containing the project file, or in any of its subdirectories.

Putting files and directories under version control

 archipel track [file|directory]+

or

 archipel untrack [file|directory]+

Querying projet status

The current project or a particular directory status can be queried by the following command :

 archipel status [file|directory]*

which gives the status of all the files in the current project, or you can also type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their status:

• Ne for new file
• Ch for changed file
• Mv for moved file
• Rm for removed file
• Cp for copied file
• Nc for newly controlled file
• Rc for released control on file
• Uc for uncontrolled file
• Nothing for an unchanged file

The first thing to understand is that status lists all file and directories, some are under Archipel control, some are not. Every changed, unchanged, moved, removed, and copied files are under Archipel version control. Newly controlled files have been just put under Archipel version control, while released control files are not under Archipel version control anymore. Uncontrolled are of course not under Archipel version control.

Status also allows:

• To include directories in the status (by default only files are shown)
• To decide which sets (new, changed, moved, etc. are considered as sets) have to be shown
• To use a specific filter to hide or show specific files or directories (like symlinks, or files ending with a specific suffix, etc.)

To get more information, you can type archipel help status.

Commiting changes

Once change

Checking out versions

Publishing a release

Intermediate usage

Annotating files and directories

 archipel annotate [file|directories] [name] [value]

Setting up filters

 archipel filter create [name]

or

 archipel filter edit [name]

or

 archipel filter remove [name]

or

 archipel filter list

Advanced usage

Creating branches

Merging branches

Subscribing to a branch

Organising branches

References

ArchipelDeltas, presents a list of current deltas available in Archipel.

Here is a short list of papers which participated in the development of Archipel :

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel
• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.

Here are some articles/pages of interest:

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel. It also references an http://www.linuxjournal.com/article.php?sid=1250 old article on RCS, which is amusing and let you understand what changed since then.
• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

Here is a list of related software:

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.
• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive?
• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.

Here are the software used by Archipel:

• ftp://ftp.astron.com/pub/file/ File, an ubiquitous utility that can guess a file MIME-type and encoding. http://www.pldaniels.com/filetype/ Filetype is a less-featured and less-mature (and I guess deprecated) alternative.

• ftp://ftp.astron.com/pub/file/ File an ubiquitous utility that can guess a file MIME-type and encoding. http://www.pldaniels.com/filetype/ Filetype is a less-featured and less-mature (and I guess deprecated) alternative.

• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.

Here are some articles/pages of interest:

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel. It also references an http://www.linuxjournal.com/article.php?sid=1250 old article on RCS, which is amusing and let you understand what changed since then.

• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.

Here are the software used by Archipel:

Here are the software used by Archipel:

• http://www.python.org Python, is the main language in which Archipel is written
• http://www.redland.opensource.ac.uk Redland is the RDF library used to store the deltas
• http://www.gnu.org/software/diffutils/diffutils.html GNU diffutils provide the indispensable diff and patch programs.
• http://www.daemonology.net/bsdiff/ BSDiff, apparently the most performant binary diff utility. You can check http://xoomer.virgilio.it/g_pochini/index.html BDiff too, but it seems to rock less.
• ftp://ftp.astron.com/pub/file/ File an ubiquitous utility that can guess a file MIME-type and encoding.

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel. It also references an http://www.linuxjournal.com/article.php?sid=1250 old article on RCS, which is amusing and let you understand what changed since then.

Here are some articles worth reading:

• http://www.linuxjournal.com/article.php?sid=1237 Diff, Patch and Friends is a Linux Journal article on these widely used tools, also used by Archipel.

Intermediate usage

 archipel annotate [file|directories] [name] [value]

Setting up filters

 archipel filter create [name]

or

 archipel filter edit [name]

or

 archipel filter remove [name]

or

 archipel filter list

Advanced usage

Creating branches

Merging branches

Subscribing to a branch

Organising branches

References

ArchipelDeltas, presents a list of current deltas available in Archipel.

Here is a short list of papers which participated in the development of Archipel :

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel

• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.
• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

Here is a list of related software:

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.
• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive?
• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.
• http://www.daemonology.net/bsdiff/ BSDiff, apparently the most performant binary diff utility. You can check http://xoomer.virgilio.it/g_pochini/index.html BDiff too, but it seems to rock less.

 archipel [command] [arguments]

Where something between @ and @ is a value of the given type. This "something" can be assigned a cardinality. For instance,

 archipel status [file|directory]+

Creating a project

 archipel create [name] [directory]?

Putting files and directories under version control

 archipel track [file|directory]+

or

 archipel untrack [file|directory]+

Querying projet status

The current project or a particular directory status can be queried by the following command :

 archipel status [file|directory]*

which gives the status of all the files in the current project, or you can also type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their status:

Merging branches

Organising branches

 archipel track <file>+

or

 archipel untrack <file>+

which gives the status of all the files in the current project, or you can also type

• Uc for uncontrolled file
• Nothing for an unchanged file

The first thing to understand is that status lists all file and directories, some are under Archipel control, some are not. Every changed, unchanged, moved, removed, and copied files are under Archipel version control. Newly controlled files have been just put under Archipel version control, while released control files are not under Archipel version control anymore. Uncontrolled are of course not under Archipel version control.

Status also allows:

• To include directories in the status (by default only files are shown)
• To decide which sets (new, changed, moved, etc. are considered as sets) have to be shown
• To use a specific filter to hide or show specific files or directories (like symlinks, or files ending with a specific suffix, etc.)

To get more information, you can type archipel help status.

Commiting changes

Once change

Checking out versions

Publishing a release

Annotating files and directories

Advanced usage

Creating branches

Subscribing to a branch

Merging branches

References

ArchipelDeltas, presents a list of current deltas available in Archipel.

Here is a short list of papers which participated in the development of Archipel :

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel

• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.

• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

Here is a list of related software:

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.

• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive?
• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.
• http://www.daemonology.net/bsdiff/ BSDiff, apparently the most performant binary diff utility. You can check http://xoomer.virgilio.it/g_pochini/index.html BDiff too, but it seems to rock less.

• http://www.daemonology.net/bsdiff/ BSDiff, apparently the most performant binary diff utility. You can check http://xoomer.virgilio.it/g_pochini/index.html BDiff too, but it seems to rock less.

• Ne for new file

• Nc for newly controlled file
• Rc for released control on file

• http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.

• http://abridgegame.org/darcs/ DARCS, a version control system which uses different types of deltas. For instances, there is a delta for replacing the occurences of a string in text files. This is where I realized that version control deltas were simply serializable and undoable commands.

Here is a short list of papers which participated in the development of Archipel :

Here is a list of related software:

 * http://www.venge.net/monotone/index.html Monotone, a distributed version control system that uses SHA-1 signatures as version identifiers. I actually liked this idea very much, and decided to use it in Archipel.

• http://wiki.gnuarch.org/ Arch, a distributed version control system that can use FTP or HTTP for communicating patches. I liked its flexibility and shell integration, but found it complicated and intrusive?
• http://prcs.sf.net PRCS, a version control system which I used and really liked for its cleanliness and simplicity. Sadly, it does not support distribution, FTP or HTTP repository checkin and checkout, or binary files. Otherwise, it would be just great.
• http://xoomer.virgilio.it/g_pochini/index.html BDiff, a binary diff utility.

ArchipelDeltas, presents a list of current deltas available in Archipel.

• Supports text and binary files
• Detects change, move, copy
• Simple command line usage
• Supports file and directory annotations
• Human-readable and program-parsable output
• Versions are SHA-1 signatures
• No annoying .CVS-like file in every dir
• Distributed development through HTTP, FTP, NFS, etc.

What makes Archipel special:

• Simple to install and use
• Can add specific deltas for refactoring operations
• Automagically detects file and directory changes, copies and moves
• Can be easily used to set up a distributed version control system, adequate to the open source development model

General document conventions

This sections presents Archipel command-line usage. Every example is given using a relatively simple syntax:

 archipel <command> <arguments>

Where something between < and > is a value of the given type. This "something" can be assigned a cardinality. For instance,

 archipel status <file|directory>+

indicates that the status command of Archipel can take 1 to many argumens of type file or directory, which are the two basic types (with litteral, meaning a text string) that Archipel commands can take.

Quick start

Putting files and directories under control

 archipel add <file>+

Project status

The current project or a particular directory status can be queried by the following command :

 archipel status <file>*

which gives the status of all the files in the current project, or you can type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their status:

Archipel aims at bringing a simple and flexible version control software that fits a distributed programming model. It is based on the concept of undoable commands (aka. deltas), which are either inferred from the file system state or explicitely executed, and then logged to a database (the repository).

General document conventions

Quick start

• http://citeseer.ist.psu.edu/westfechtel00layered.html A Layered Architecture for Uniform Version Management, is the paper that motivated me to start working on Archipel

• http://www.idt.unit.no/~bjornmu/thesis/thesis.html Versioning in a Software Engineering Database - the Change Oriented Way, by Bjørn P. Munch, which seems to be one of the original work that allowed the above paper to be written.

• Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

References

'Versioning in a Software Engineering Database - the Change Oriented Way, Bjørn P. Munch, http://www.idt.unit.no/~bjornmu/thesis/thesis.html here, and particularily the portion on http://www.idt.unit.no/~bjornmu/thesis/node77.html change-oriented versionning.

Links

Archipel aims at bringing a simple and flexible version control software that fits a distributed programming model. It is based on the concept of undoable commands (aka. deltas), which are inferred from the file system state and logged to a database (the repository).

From Archipel's perspective, version control is simply a generalization of an undo mechanism, where deltas are simply serializable undoable commands.

Links

Yann Dirson's http://ydirson.free.fr/en/software/scm/vc.txt thoughts on version control

• Nothing for an unchanged file

• Ad for added file
• Ch for changed file
• Mv for moved file
• Rm for removed file
• Cp for copied file

• Ad for added file
• Ch for changed file
• Mv for moved file
• Rm for removed file
• Cp for copied file

• No annoying .CVS-like file in every dir

• Ad for added file
• Ch for changed file
• Mv for moved file
• Rm for removed file
• Co for copied file

Simple command line usage

Commiting changes

Checking out versions

Publishing a release

Annotating files and directories

Advanced usage

Creating branches

Subscribing to a branch

Merging branches

Simple command line usage

Checking out versions

Annotating files and directories

Advanced usage

Creating branches

Subscribing to a branch

Merging branches

This sections presents Archipel command-line usage. Every example is given using a relatively simple syntax:

 archipel <command> <arguments>

Where something between < and > is a value of the given type. This "something" can be assigned a cardinality. For instance,

 archipel status <file|directory>+

indicates that the status command of Archipel can take 1 to many argumens of type file or directory, which are the two basic types (with litteral, meaning a text string) that Archipel commands can take.

Putting files and directories under control

 archipel add <file>+

Project status

The current project or a particular directory status can be queried by the following command :

 archipel status <file>*

which gives the status of all the files in the current project, or you can type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The status command ouputs a list of files prefixed by their status:

• 'Ad' for added file
• 'Ch' for changed file
• 'Mv' for moved file
• 'Rm' for removed file
• 'Co' for copied file
• Nothing for an unchanged file

Commiting changes

Once change

Publishing a release

Features:

• Versions are SHA-1 signatures
• Project-oriented
• No annoying @.CVS@-like file in every dir

Command line usage

Project status

The current project or a particular directory status can be queried by the following command :

 archipel status

which gives the status of all the files in the current project, or you can type

 archipel status .

to know what has changed in the current directory. Note that you can indicate any directory under Archipel control.

The @status@ command ouputs a list of files prefixed by their status:

• 'Ad' for added file
• 'Ch' for changed file
• 'Mv' for moved file
• 'Rm' for removed file
• 'Co' for copied file
• Nothing for an unchanged file

Archipel Version Control

Archipel Version Control

Archipel aims at bringing a simple and flexible version control software that fits a distributed programming model.