journal: Document the new format for gitdate.
ClosedPublic
Actions

Authored by vlorentz on Jan 21 2022, 12:00 PM.

Details

Reviewers

douardda
olasd
ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3752: Store/represent time offsets as strings

Commits

rDDOCef5dffbebfa3: journal: Document the new format for gitdate.

Summary

This documents the new behavior introduced by D7011, which will be released as swh-mode v5.0.0

Diff Detail

Repository

rDDOC Development documentation

Branch

master

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 26575
Build 41565: Phabricator diff pipeline on Jenkins for swh-docs	Jenkins console · Jenkins
Build 41564: arc lint + arc unit

Event Timeline

vlorentz created this revision.Jan 21 2022, 12:00 PM

vlorentz added 2 blocking reviewer(s): douardda, olasd.Jan 21 2022, 12:01 PM

Build has FAILED

Patch application report for D7003 (id=25396)

Rebasing onto bfa06588e5...

Current branch diff-target is up to date.

Changes applied before test

commit dca38ddd6a762a140d63e5cd6ce025ee9389e344
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Fri Jan 21 12:00:33 2022 +0100

    journal: Document the new format for gitdate.

Link to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/101/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/101/console

Harbormaster returned this revision to the author for changes because remote builds failed.Jan 21 2022, 12:10 PM

Harbormaster failed remote builds in B26240: Diff 25396!

vlorentz added a task: T3752: Store/represent time offsets as strings.Jan 21 2022, 1:29 PM

fix typo

vlorentz edited the summary of this revision. (Show Details)Jan 21 2022, 3:00 PM

vlorentz mentioned this in D7011: Revert "Restore 'offset' and 'negative_utc' arguments and make them optional".Jan 21 2022, 3:05 PM

Build has FAILED

Patch application report for D7003 (id=25417)

Rebasing onto bfa06588e5...

Current branch diff-target is up to date.

Changes applied before test

commit bf1e0b1185422827b2b7941fb009001f78c3af1a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Fri Jan 21 12:00:33 2022 +0100

    journal: Document the new format for gitdate.

Link to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/103/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/103/console

Harbormaster returned this revision to the author for changes because remote builds failed.Jan 21 2022, 3:09 PM

Harbormaster failed remote builds in B26260: Diff 25417!

Build is green

Patch application report for D7003 (id=25417)

Rebasing onto 7ff0c981c3...

First, rewinding head to replay your work on top of it...
Applying: journal: Document the new format for gitdate.

Changes applied before test

commit 3850878d4e8164a25f8bf9d3bf09efca507d86fc
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Fri Jan 21 12:00:33 2022 +0100

    journal: Document the new format for gitdate.

See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/106/ for more details.

Harbormaster completed remote builds in B26260: Diff 25417.Jan 25 2022, 1:15 PM

vlorentz requested review of this revision.Jan 25 2022, 1:15 PM

ardumont accepted this revision as: ardumont.Jan 25 2022, 2:24 PM

vlorentz mentioned this in T3890: schema of timezones in the journal.Jan 26 2022, 11:57 AM

douardda added inline comments.Jan 26 2022, 2:18 PM

docs/journal.rst
608	I find it confusing to list fields to omit rather than to keep. A glimpse at the list just below tell me that swh-model>=5 requires offset and negative_utc while it's the other way around...

douardda added inline comments.Jan 26 2022, 2:23 PM

docs/journal.rst
614	(genuinely) so what should the user do if s.he retrieves an object with inconsistent offset_bytes vs (offset + negative_utc)?
615	emphasis (bold) "new format" would be helpful as well (same for "old format")

douardda requested changes to this revision.Jan 26 2022, 2:24 PM

This revision now requires changes to proceed.Jan 26 2022, 2:24 PM

vlorentz added inline comments.Jan 26 2022, 3:02 PM

docs/journal.rst
608	indeed
614	ignore offset + negative_utc, offset_bytes is always more correct

douardda added inline comments.Jan 26 2022, 3:50 PM

docs/journal.rst
615	ignore offset + negative_utc, offset_bytes is always more correct should be explicitly written then

make descriptions less convoluted.

vlorentz marked 4 inline comments as done.Feb 7 2022, 12:06 PM

Build is green

Patch application report for D7003 (id=25745)

Rebasing onto ce59060cbc...

Current branch diff-target is up to date.

Changes applied before test

commit ef5dffbebfa3322db4ece3a0c531b174f357689a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Fri Jan 21 12:00:33 2022 +0100

    journal: Document the new format for gitdate.

See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/111/ for more details.

Harbormaster completed remote builds in B26575: Diff 25745.Feb 7 2022, 12:15 PM

This revision was not accepted when it landed; it landed in state Needs Review.Feb 7 2022, 1:06 PM

Closed by commit rDDOCef5dffbebfa3: journal: Document the new format for gitdate. (authored by vlorentz). · Explain Why

This revision was automatically updated to reflect the committed changes.

vlorentz added a commit: rDDOCef5dffbebfa3: journal: Document the new format for gitdate..