Clarify some metadata and change the keys for date-related metadata.

Review Request #11752 — Created July 28, 2021 and submitted

Information

DiffX
master

Reviewers

Based on feedback, the purpose of "committer" vs. "author" and "date"
vs. "committer date" wasn't entirely clear, as not all SCMs
differentiated between these.

"date" and "committer date" also seemed to be backwards from general
usage.

To address this:

  1. "committer date" was renamed to "date", and is now the primary date
    representing the change (whether the commit date or when the diff was
    generated).
  2. The old "date" was renamed to "author date", and is now available
    when the date of the authorship (e.g., creation of the diff or
    posting of a review) is available and meaningfully useful.

  3. Descriptions for all these fields were fleshed out, describing their
    intent, purpose, how they differ from each other, when they're
    expected to be present, and what they should contain.

Built the docs. Read through them, checked links, and checked for
spelling errors.

Summary ID
Clarify some metadata and change the keys for date-related metadata.
Based on feedback, the purpose of "committer" vs. "author" and "date" vs. "committer date" wasn't entirely clear, as not all SCMs differentiated between these. "date" and "committer date" also seemed to be backwards from general usage. To address this: 1. "committer date" was renamed to "date", and is now the primary date representing the change (whether the commit date or when the diff was generated). 2. The old "date" was renamed to "author date", and is now available when the date of the authorship (e.g., creation of the diff or posting of a review) is available and meaningfully useful. 3. Descriptions for all these fields were fleshed out, describing their intent, purpose, how they differ from each other, when they're expected to be present, and what they should contain.
6d06699805d0be34abffc5c77120508c0761fb36
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to master (83e1e56)
Loading...