Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: git diff reformatting #1769

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

doc: git diff reformatting #1769

wants to merge 5 commits into from

Commits on Nov 18, 2024

  1. doc: git-diff: apply new documentation guidelines 

    The documentation for git-diff has been updated to follow the new
documentation guidelines. The following changes have been applied to
the series of patches:

- switching the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- use _<placeholder>_ instead of <placeholder> in the description
- use `backticks for keywords and more complex option
descriptions`. The new rendering engine will apply synopsis rules to
these spans.
- prevent git-diff from self-referencing itself via gitlink macro when
the generated link would point to the same page.

Signed-off-by: Jean-Noël Avila <[email protected]>
    @jnavila
    jnavila committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    fd3ee13 View commit details
    Browse the repository at this point in the history

  2. doc: git-diff: apply format changes to diff-options 

    The format change is only applied to the sections of the file that are
filtered in git-diff.

Signed-off-by: Jean-Noël Avila <[email protected]>
    @jnavila
    jnavila committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    a0a3986 View commit details
    Browse the repository at this point in the history

  3. doc: git-diff: apply format changes to diff-format 

    Signed-off-by: Jean-Noël Avila <[email protected]>
    @jnavila
    jnavila committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    aca3573 View commit details
    Browse the repository at this point in the history

  4. doc: git-diff: apply format changes to diff-generate-patch 

    Signed-off-by: Jean-Noël Avila <[email protected]>
    @jnavila
    jnavila committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    0e6162d View commit details
    Browse the repository at this point in the history

  5. doc: git-diff: apply format changes to config part 

    By the way, we also change the sentences where git-diff would refer to
itself, so that no link is created in the HTML output.

Signed-off-by: Jean-Noël Avila <[email protected]>
    @jnavila
    jnavila committed Nov 18, 2024
    Configuration menu
    Copy the full SHA
    d350237 View commit details
    Browse the repository at this point in the history