Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example svnrdump command in README. #67

Merged
merged 1 commit into from
Apr 21, 2024
Merged

Add example svnrdump command in README. #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
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
Loading