From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 1851) id B5EE8383E805; Thu, 21 May 2020 15:18:14 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org B5EE8383E805 To: gcc-cvs-wwwdocs@gcc.gnu.org Subject: gcc-wwwdocs branch master updated. 15d62b0022c3f77aae1b7a5a7512e1692f0f17f7 X-Git-Refname: refs/heads/master X-Git-Reftype: branch X-Git-Oldrev: 7cca2f69e2f533cae99b16855716fe51e634312f X-Git-Newrev: 15d62b0022c3f77aae1b7a5a7512e1692f0f17f7 Message-Id: <20200521151814.B5EE8383E805@sourceware.org> Date: Thu, 21 May 2020 15:18:14 +0000 (GMT) From: Martin Liska X-BeenThere: gcc-cvs-wwwdocs@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-cvs-wwwdocs mailing list List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 21 May 2020 15:18:14 -0000 This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "gcc-wwwdocs". The branch, master has been updated via 15d62b0022c3f77aae1b7a5a7512e1692f0f17f7 (commit) from 7cca2f69e2f533cae99b16855716fe51e634312f (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 15d62b0022c3f77aae1b7a5a7512e1692f0f17f7 Author: Martin Liska Date: Thu May 21 17:17:25 2020 +0200 Remove coloring from ChangeLogs section. diff --git a/htdocs/codingconventions.html b/htdocs/codingconventions.html index d2e73962..6ae962ea 100644 --- a/htdocs/codingconventions.html +++ b/htdocs/codingconventions.html @@ -132,47 +132,47 @@ a large batch of changes.

Components

    -
  • git_description - a leading text with git commit description
    • -
  • committer_timestamp - line with timestamp and an author name and email (2 spaces before and after name)
    - example: 2020-04-23␣␣Martin Liska␣␣<mliska@suse.cz>
    • -
  • additional_author - line with additional commit author name and email (starting with a tabular and 4 spaces)
    - example: \t␣␣␣␣Martin Liska␣␣<mliska@suse.cz>
    • -
  • changelog_location - a location to a ChangeLog file
    - supported formats: a/b/c/ChangeLog, a/b/c/ChangeLog:, a/b/c/ (where ChangeLog file lives in the folder), \ta/b/c/ and a/b/c
    • -
  • pr_entry - bug report reference
    - example: \tPR component/12345
    • -
  • changelog_file - a modified file mentined in a ChangeLog: - supported formats: \t* a/b/c/file.c:, \t* a/b/c/file.c (function):, \t* a/b/c/file1.c, a/b/c/file2.c:
    • -
  • changelog_file_comment - line that follows a changelog_file with description of changes in the file; - must start with \t
    • -
  • co_authored_by - GitHub format for a Co-Authored-By
    • +
  • git_description - a leading text with git commit description
    • +
  • committer_timestamp - line with timestamp and an author name and email (2 spaces before and after name)
    + example: 2020-04-23␣␣Martin Liska␣␣<mliska@suse.cz>
    • +
  • additional_author - line with additional commit author name and email (starting with a tabular and 4 spaces)
    + example: \t␣␣␣␣Martin Liska␣␣<mliska@suse.cz>
    • +
  • changelog_location - a location to a ChangeLog file
    + supported formats: a/b/c/ChangeLog, a/b/c/ChangeLog:, a/b/c/ (where ChangeLog file lives in the folder), \ta/b/c/ and a/b/c
    • +
  • pr_entry - bug report reference
    + example: \tPR component/12345
    • +
  • changelog_file - a modified file mentined in a ChangeLog: + supported formats: \t* a/b/c/file.c:, \t* a/b/c/file.c (function):, \t* a/b/c/file1.c, a/b/c/file2.c:
    • +
  • changelog_file_comment - line that follows a changelog_file with description of changes in the file; + must start with \t
    • +
  • co_authored_by - GitHub format for a Co-Authored-By

Format rules

    -
  • git_description - optional; ends right before one of the other compoments is found
    • -
  • committer_timestamp - optional; when found before a changelog_file, then it is added +
  • git_description - optional; ends right before one of the other compoments is found
    • +
  • committer_timestamp - optional; when found before a changelog_file, then it is added to each changelog entry
    • -
  • additional_author - optional
    • -
  • changelog_location - optional; parser attempts to identify ChangeLog file based - on modified files; $changelog_location belonging to a different ChangeLog must +
  • additional_author - optional
    • +
  • changelog_location - optional; parser attempts to identify ChangeLog file based + on modified files; $changelog_location belonging to a different ChangeLog must be separated with an empty line
    • -
  • pr_entry - optional; can contain any number of PR entries
    • -
  • changelog_file - each changelog_location must contain at least one file
    • -
  • changelog_file_comment - optional
    • -
  • co_authored_by - optional, can contain more than one
    • +
  • pr_entry - optional; can contain any number of PR entries
    • +
  • changelog_file - each changelog_location must contain at least one file
    • +
  • changelog_file_comment - optional
    • +
  • co_authored_by - optional, can contain more than one

Documented behaviour

    -
  • a missing changelog_location file location can be deduced based on group of changelog_files
    • +
  • a missing changelog_location file location can be deduced based on group of changelog_files
  • script automatically generates missing "New file." entries for files that are added in a commit
  • changed files that are not mentioned in a ChangeLog file generate an error
  • similarly for unchanged files that are mentioned in a ChangeLog file
  • a commit author and committer date stamp can be automatically deduced from a git commit - we recommend to use it
    • -
  • co_authored_by is added to each ChangeLog entry
    • +
  • co_authored_by is added to each ChangeLog entry
  • a PR component is checked against list of valid components
  • ChangeLog files, DATESTAMP, BASE-VER and DEV-PHASE can be modified only separately from other files
----------------------------------------------------------------------- Summary of changes: htdocs/codingconventions.html | 50 +++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 25 deletions(-) hooks/post-receive -- gcc-wwwdocs