public inbox for gcc-cvs-wwwdocs@sourceware.org help / color / mirror / Atom feed
From: Martin Liska <marxin@sourceware.org> To: gcc-cvs-wwwdocs@gcc.gnu.org Subject: gcc-wwwdocs branch master updated. 15d62b0022c3f77aae1b7a5a7512e1692f0f17f7 Date: Thu, 21 May 2020 15:18:14 +0000 (GMT) [thread overview] Message-ID: <20200521151814.B5EE8383E805@sourceware.org> (raw) [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #1: Type: text/plain, Size: 7724 bytes --] 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 <mliska@suse.cz> 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.</p> <h3>Components</h3> <ul> - <li><code class="other">git_description</code> - a leading text with git commit description</li> - <li><code class="other">committer_timestamp</code> - line with timestamp and an author name and email (2 spaces before and after name) <br> - example: <code class="other">2020-04-23␣␣Martin Liska␣␣<mliska@suse.cz></code></li> - <li><code class="other">additional_author</code> - line with additional commit author name and email (starting with a tabular and 4 spaces) <br> - example: <code class="other">\t␣␣␣␣Martin Liska␣␣<mliska@suse.cz></code></li> - <li><code class="other">changelog_location</code> - a location to a ChangeLog file <br> - supported formats: <code class="other">a/b/c/ChangeLog</code>, <code class="other">a/b/c/ChangeLog:</code>, <code class="other">a/b/c/</code> (where ChangeLog file lives in the folder), <code class="other">\ta/b/c/</code> and <code class="other">a/b/c</code></li> - <li><code class="other">pr_entry</code> - bug report reference <br> - example: <code class="other">\tPR component/12345</code></li> - <li><code class="other">changelog_file</code> - a modified file mentined in a ChangeLog: - supported formats: <code class="other">\t* a/b/c/file.c:</code>, <code class="other">\t* a/b/c/file.c (function):</code>, <code class="other">\t* a/b/c/file1.c, a/b/c/file2.c:</code></li> - <li><code class="other">changelog_file_comment</code> - line that follows a <code class="other">changelog_file</code> with description of changes in the file; - must start with <code class="other">\t</code></li> - <li><code class="other">co_authored_by</code> - <a href="https://help.github.com/en/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors">GitHub format</a> for a Co-Authored-By</li> + <li><code>git_description</code> - a leading text with git commit description</li> + <li><code>committer_timestamp</code> - line with timestamp and an author name and email (2 spaces before and after name) <br> + example: <code>2020-04-23␣␣Martin Liska␣␣<mliska@suse.cz></code></li> + <li><code>additional_author</code> - line with additional commit author name and email (starting with a tabular and 4 spaces) <br> + example: <code>\t␣␣␣␣Martin Liska␣␣<mliska@suse.cz></code></li> + <li><code>changelog_location</code> - a location to a ChangeLog file <br> + supported formats: <code>a/b/c/ChangeLog</code>, <code>a/b/c/ChangeLog:</code>, <code>a/b/c/</code> (where ChangeLog file lives in the folder), <code>\ta/b/c/</code> and <code>a/b/c</code></li> + <li><code>pr_entry</code> - bug report reference <br> + example: <code>\tPR component/12345</code></li> + <li><code>changelog_file</code> - a modified file mentined in a ChangeLog: + supported formats: <code>\t* a/b/c/file.c:</code>, <code>\t* a/b/c/file.c (function):</code>, <code>\t* a/b/c/file1.c, a/b/c/file2.c:</code></li> + <li><code>changelog_file_comment</code> - line that follows a <code>changelog_file</code> with description of changes in the file; + must start with <code>\t</code></li> + <li><code>co_authored_by</code> - <a href="https://help.github.com/en/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors">GitHub format</a> for a Co-Authored-By</li> </ul> <h3>Format rules</h3> <ul> - <li><code class="other">git_description</code> - optional; ends right before one of the other compoments is found</li> - <li><code class="other">committer_timestamp</code> - optional; when found before a <code class="other">changelog_file</code>, then it is added + <li><code>git_description</code> - optional; ends right before one of the other compoments is found</li> + <li><code>committer_timestamp</code> - optional; when found before a <code>changelog_file</code>, then it is added to each changelog entry</li> - <li><code class="other">additional_author</code> - optional</li> - <li><code class="other">changelog_location</code> - optional; parser attempts to identify ChangeLog file based - on modified files; <code class="other">$changelog_location</code> belonging to a different ChangeLog must + <li><code>additional_author</code> - optional</li> + <li><code>changelog_location</code> - optional; parser attempts to identify ChangeLog file based + on modified files; <code>$changelog_location</code> belonging to a different ChangeLog must be separated with an empty line</li> - <li><code class="other">pr_entry</code> - optional; can contain any number of PR entries</li> - <li><code class="other">changelog_file</code> - each <code>changelog_location</code> must contain at least one file</li> - <li><code class="other">changelog_file_comment</code> - optional</li> - <li><code class="other">co_authored_by</code> - optional, can contain more than one</li> + <li><code>pr_entry</code> - optional; can contain any number of PR entries</li> + <li><code>changelog_file</code> - each <code>changelog_location</code> must contain at least one file</li> + <li><code>changelog_file_comment</code> - optional</li> + <li><code>co_authored_by</code> - optional, can contain more than one</li> </ul> <h3>Documented behaviour</h3> <ul> - <li>a missing <code class="other">changelog_location</code> file location can be deduced based on group of <code class="other">changelog_file</code>s</li> + <li>a missing <code>changelog_location</code> file location can be deduced based on group of <code>changelog_file</code>s</li> <li>script automatically generates missing "New file." entries for files that are added in a commit</li> <li>changed files that are not mentioned in a ChangeLog file generate an error</li> <li>similarly for unchanged files that are mentioned in a ChangeLog file</li> <li>a commit author and committer date stamp can be automatically deduced from a git commit - we recommend to use it</li> - <li><code class="other">co_authored_by</code> is added to each ChangeLog entry</li> + <li><code>co_authored_by</code> is added to each ChangeLog entry</li> <li>a PR component is checked against list of valid components</li> <li><code>ChangeLog</code> files, <code>DATESTAMP</code>, <code>BASE-VER</code> and <code>DEV-PHASE</code> can be modified only separately from other files</li> </ul> ----------------------------------------------------------------------- Summary of changes: htdocs/codingconventions.html | 50 +++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 25 deletions(-) hooks/post-receive -- gcc-wwwdocs
reply other threads:[~2020-05-21 15:18 UTC|newest] Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200521151814.B5EE8383E805@sourceware.org \ --to=marxin@sourceware.org \ --cc=gcc-cvs-wwwdocs@gcc.gnu.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).