Skip to content

Commit 404ec8a

Browse files
author
Alessandro Bertulli
committed
Use <pre></pre> syntax
1 parent ef05c84 commit 404ec8a

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ This CMake module exports both a C and a C++ API. Both are accessed by including
4545
call after including the module.
4646

4747
| Description | C API | C++ API[^1] | Output | Git command |
48-
| ----------- | ----- | ---------- | ------ | ----------- |
49-
| Check if repo is correctly configured | `bool git_IsPopulated()` | `bool git::IsPopulated()` | `true`/`false` | (Set to `0` if git commands signal an error) |
50-
| Check if the worktree is dirty (there are uncommited changes)[^2] | `bool git_AnyUncommittedChanges()` | `bool git::AnyUncommittedChanges()` | `true`/`false` | `git status --porcelain -unormal` |
51-
| Get the author's name | <pre>const char* git_AuthorName()</pre> | `const StringOrView& git::AuthorName()` | `"Andrew Hardin"` | `git show -s "--format=%an"` |
52-
| Get the author's email | <code>const char* git_AuthorEmail()</code> | `const StringOrView& git::AuthorEmail()` | `"andrew.hardin@github.com"` | `git show -s "--format=%ae"` |
53-
| Get the commit full SHA1 ID | <pre><code>const char* git_CommitSHA1()</code></pre> | `const StringOrView& git::CommitSHA1()` | `"815da8c5a326f10931c0ce5944c62da11bbe784e"` | `git show -s "--format=%H"` |
54-
| Get the commit date | <code><pre>const char* git_CommitDate()</pre></code> | `const StringOrView& git::CommitDate()` | `"2025-11-05 17:01:07 +0100"` | `git show -s "--format=%ci"` |
55-
| Get the commit subject | `const char* git_CommitSubject()` | `const StringOrView& git::CommitSubject()` | `"An example commit subject"` | `git show -s "--format=%s"` |
56-
| Get the commit full body | `const char* git_CommitBody()` | `const StringOrView& git::CommitBody()` | `"An example commit body\nthat can span multiple lines"`[^3] | `git show -s "--format=%b"` |
57-
| Get the commit describe string | `const char* git_Describe()` | `const StringOrView& git::Describe()` | `"v1.0.2-5g815da8c"` | `git describe --always` |
58-
| Get the current branch | `const char* git_Branch()` | `const StringOrView& git::Branch()` | `"main"` | `git symbolic-ref --short -q` |
48+
| ----------- | ----- | ----------- | ------ | ----------- |
49+
| Check if repo is correctly configured | <pre>bool git_IsPopulated()</pre> | <pre>bool git::IsPopulated()</pre> | `true`/`false` | (Set to `0` if git commands signal an error) |
50+
| Check if the worktree is dirty (there are uncommited changes)[^2] | <pre>bool git_AnyUncommittedChanges()</pre> | <pre>bool git::AnyUncommittedChanges()</pre> | `true`/`false` | <pre>git status --porcelain -unormal</pre> |
51+
| Get the author's name | <pre>const char* git_AuthorName()</pre> | <pre>const StringOrView& git::AuthorName()</pre> | `"Andrew Hardin"` | <pre>git show -s "--format=%an"</pre> |
52+
| Get the author's email | <pre>const char* git_AuthorEmail()</pre> | <pre>const StringOrView& git::AuthorEmail()</pre> | `"name.surname@github.com"` | <pre>git show -s "--format=%ae"</pre> |
53+
| Get the commit full SHA1 ID | <pre>const char* git_CommitSHA1()</pre> | <pre>const StringOrView& git::CommitSHA1()</pre> | `"815da8c5a326f10931c0ce5944c62da11bbe784e"` | <pre>git show -s "--format=%H"</pre> |
54+
| Get the commit date | <pre>const char* git_CommitDate()</pre> | <pre>const StringOrView& git::CommitDate()</pre> | `"2025-11-05 17:01:07 +0100"` | <pre>git show -s "--format=%ci"</pre> |
55+
| Get the commit subject | <pre>const char* git_CommitSubject()</pre> | <pre>const StringOrView& git::CommitSubject()</pre> | `"An example commit subject"` | <pre>git show -s "--format=%s"</pre> |
56+
| Get the commit full body | <pre>const char* git_CommitBody()</pre> | <pre>const StringOrView& git::CommitBody()</pre> | `"An example commit body\nthat can span multiple lines"`[^3] | <pre>git show -s "--format=%b"</pre> |
57+
| Get the commit describe string | <pre>const char* git_Describe()</pre> | <pre>const StringOrView& git::Describe()</pre> | `"v1.0.2-5g815da8c"` | <pre>git describe --always</pre> |
58+
| Get the current branch | <pre>const char* git_Branch()</pre> | <pre>const StringOrView& git::Branch()</pre> | `"main"` | <pre>git symbolic-ref --short -q</pre> |
5959

6060
[^1]: The `StringOrView` type is an alias to `std::string`. By setting the configuration variable `GIT_VERSION_USE_STRING_VIEW` to true, it becomes an alias to `std::string_view`.
6161
[^2]: By default, it considers untracked files as a dirty worktree. By setting the configuration variable `GIT_IGNORE_UNTRACKED` to true, it ignores them and only considers tracked modified files.

0 commit comments

Comments
 (0)