Skip to content

Commit

Permalink
Add example svnrdump command in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
cstroe committed Apr 21, 2024
1 parent b1229ca commit 3e353aa
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,20 @@ An API for reading, editing, and writing SVN dump files.

## Background

SVN dump files are created via the `svnadmin dump` command, and contain all the
history of an SVN repository. An SVN dump file contains a list of revisions
SVN dump files are created via the `svnadmin dump` or `svnrdump dump` commands, and contain all the
history of an SVN repository.

Example command for dumping a random Sourceforce project:

```
svnrdump dump https://svn.code.sf.net/p/barbecue/code > barbecue.dump
```

This will create a file named `barbecue.dump` which follows the SVN dump file format.
The SVN dump file format is a "serialized description of the actions required to
(re)build a version history" (see [original docs](https://svn.apache.org/repos/asf/subversion/trunk/notes/dump-load-format.txt).

An SVN dump file contains a list of revisions
(see [`Revision`](src/main/java/com/github/cstroe/svndumpgui/api/Revision.java)), and each
revision contains a list of nodes (see [`Node`](src/main/java/com/github/cstroe/svndumpgui/api/Node.java)).

Expand Down

0 comments on commit 3e353aa

Please sign in to comment.