Skip to content

Commit

Permalink
[Java] Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mjpt777 committed Jan 18, 2021
1 parent 2e5f3b2 commit bbfeeed
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 15 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ If you would like to contribute code you can do so through GitHub by sending a p

When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

[![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/real-logic/Aeron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) To chat with other Aeron contributors.

## License

By contributing your code, you agree to license your contribution under the terms of the APLv2:
Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Aeron
=====

[![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/real-logic/Aeron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) To chat with other Aeron users and contributors.

[![GitHub](https://img.shields.io/github/license/real-logic/Aeron.svg)](https://github.com/real-logic/aeron/blob/master/LICENSE)
[![Javadocs](https://www.javadoc.io/badge/io.aeron/aeron-all.svg)](https://www.javadoc.io/doc/io.aeron/aeron-all)

Expand Down
19 changes: 6 additions & 13 deletions aeron-archive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,8 @@ Persisted Format
=====
The Archive is backed by 3 file types, all of which are expected to reside in the `archiveDir`.

- **Catalog (one per archive):** The catalog contains fixed length (1k) records of recording
descriptors. The descriptors can be queried as described above. Each descriptor entry is 1k aligned,
and as the `recordingId` is a simple sequence, this means lookup is a dead reckoning operation.
Each entry has a header (32 bytes) followed by the RecordingDescriptor, the header contains the encoded
length of the RecordingDescriptor. See the codec schema for full descriptor details.
- **Catalog (one per archive):** The catalog contains records of recording descriptors. The descriptors can
be queried as described above. See the codec schema for full descriptor details.

- **Recording Segment Files (many per recorded stream):** This is where the recorded data is kept.
Recording segments follow the naming convention of: `<recordingId>-<segment base position>.rec`
Expand All @@ -106,16 +103,12 @@ The Archive is backed by 3 file types, all of which are expected to reside in th
Migration
=====
The Archive may need to be migrated between major versions. This migration will be evident if attempting
to run `CatalogTool` with the `describe` command on the archive directory. A previous version will
only be readable by a previous version of `CatalogTool`. To migrate the archive, please follow
to run `ArchiveTool` with the `describe` command on the archive directory. A previous version will
only be readable by a previous version of `ArchiveTool`. To migrate the archive, please follow
the steps below.

- Shutdown the Archive and ensure all recordings have a stop position.
- Take a backup of the Archive directory.
- Run `CatalogTool` command `migrate`. Information on versions, etc. will be displayed. Errors
- Run `ArchiveTool` command `migrate`. Information on versions, etc. will be displayed. Errors
will also be displayed.
- Run `CatalogTool` command `verify` to check for validity.

This is a list of Version that require migration are below.

- Version previous to 1.0.0 must migrate due to the segment file name change.
- Run `ArchiveTool` command `verify` to check for validity.

0 comments on commit bbfeeed

Please sign in to comment.