https://github.com/stellar/mddiffcheck
A tool for checking that diffs in markdown files apply.
https://github.com/stellar/mddiffcheck
Last synced: about 1 year ago
JSON representation
A tool for checking that diffs in markdown files apply.
- Host: GitHub
- URL: https://github.com/stellar/mddiffcheck
- Owner: stellar
- License: apache-2.0
- Created: 2021-05-24T20:22:21.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T18:56:10.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T07:11:18.547Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 8
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mddiffcheck
A tool for checking that git diffs that have been in markdown files apply successfully to the repo they're intended.
This tool was created to verify that git diffs included in [stellar-protocol] Core Advancement Protocols (CAPs) are valid.
The tool runs `git` as a subprocess and requires it to be installed.
[stellar-protocol]: https://github.com/stellar/stellar-protocol
## Usage
```
$ go install github.com/stellar/mddiffcheck@latest
```
```
$ mddiffcheck -help
Usage of mddiffcheck:
mddiffcheck -repo= [markdown-file] ...
Example:
mddiffcheck -repo=https://github.com/user/repo doc1.md doc2.md
Flags:
-help
print this help
-repo string
repository to verify diffs against
```
When adding diffs into markdown, use the following format:
- Specify the code block is a diff with `diff` on the same line as the backticks.
- Specify the base git reference the diff applies to, either a tag or a commit sha, using the `mddiffcheck.base=` parameter.
- Or, specify the diff should be ignored and not checked, using the `mddiffcheck.ignore=true` parameter.
````
# Heading
## Subheading
```diff mddiffcheck.fetch=pull/3380/head mddiffcheck.base=v16.0.0
diff --git a/src/xdr/Stellar-ledger-entries.x b/src/xdr/Stellar-ledger-entries.x
index 0e7bc842..68c52758 100644
--- a/src/xdr/Stellar-ledger-entries.x
+++ b/src/xdr/Stellar-ledger-entries.x
@@ -114,12 +114,15 @@ enum AccountFlags
// Trustlines are created with clawback enabled set to "true",
// and claimable balances created from those trustlines are created
// with clawback enabled set to "true"
- AUTH_CLAWBACK_ENABLED_FLAG = 0x8
+ AUTH_CLAWBACK_ENABLED_FLAG = 0x8,
+ // Trustlines are created with revocation disabled set to "true"
+ AUTH_NOT_REVOCABLE_FLAG = 0x10
};
// mask for all valid flags
```
````