aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-19 15:14:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix up internal references now files have moved.

Browse Source 
And tools/check-markdown.sh didn't do anything: remove it.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2023-07-15 13:44:00 +09:30
parent 9f8889eb8c
commit 5132fea44e
3 changed files with 4 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@@ -520,9 +520,6 @@ check-whitespace/%: %
check-whitespace: check-whitespace/Makefile check-whitespace/tools/check-bolt.c $(ALL_NONGEN_SRCFILES:%=check-whitespace/%) check-whitespace: check-whitespace/Makefile check-whitespace/tools/check-bolt.c $(ALL_NONGEN_SRCFILES:%=check-whitespace/%)
check-markdown:
@tools/check-markdown.sh
check-spelling: check-spelling:
@tools/check-spelling.sh @tools/check-spelling.sh
@@ -574,7 +571,7 @@ check-amount-access:
@! (git grep -nE "(->|\.)(milli)?satoshis" -- "*.c" "*.h" ":(exclude)common/amount.*" ":(exclude)*/test/*" | grep -v '/* Raw:') @! (git grep -nE "(->|\.)(milli)?satoshis" -- "*.c" "*.h" ":(exclude)common/amount.*" ":(exclude)*/test/*" | grep -v '/* Raw:')
@! git grep -nE "\\(struct amount_(m)?sat\\)" -- "*.c" "*.h" ":(exclude)common/amount.*" ":(exclude)*/test/*" @! git grep -nE "\\(struct amount_(m)?sat\\)" -- "*.c" "*.h" ":(exclude)common/amount.*" ":(exclude)*/test/*"
check-source: check-makefile check-source-bolt check-whitespace check-markdown check-spelling check-python check-includes check-cppcheck check-shellcheck check-setup_locale check-tmpctx check-discouraged-functions check-amount-access check-source: check-makefile check-source-bolt check-whitespace check-spelling check-python check-includes check-cppcheck check-shellcheck check-setup_locale check-tmpctx check-discouraged-functions check-amount-access
full-check: check check-source full-check: check check-source
@@ -801,7 +798,7 @@ MAN1PAGES = $(filter %.1,$(MANPAGES))
MAN5PAGES = $(filter %.5,$(MANPAGES)) MAN5PAGES = $(filter %.5,$(MANPAGES))
MAN7PAGES = $(filter %.7,$(MANPAGES)) MAN7PAGES = $(filter %.7,$(MANPAGES))
MAN8PAGES = $(filter %.8,$(MANPAGES)) MAN8PAGES = $(filter %.8,$(MANPAGES))
DOC_DATA = README.md doc/INSTALL.md doc/HACKING.md LICENSE DOC_DATA = README.md LICENSE
install-data: installdirs $(MAN1PAGES) $(MAN5PAGES) $(MAN7PAGES) $(MAN8PAGES) $(DOC_DATA) install-data: installdirs $(MAN1PAGES) $(MAN5PAGES) $(MAN7PAGES) $(MAN8PAGES) $(DOC_DATA)
@$(NORMAL_INSTALL) @$(NORMAL_INSTALL)

4
README.md
View File

@@ -41,7 +41,7 @@ There are 4 supported installation options:
- Installation of a pre-compiled binary from the [release page][releases] on GitHub. - Installation of a pre-compiled binary from the [release page][releases] on GitHub.
- Using one of the [provided docker images][dockerhub] on the Docker Hub. - Using one of the [provided docker images][dockerhub] on the Docker Hub.
- Compiling the source code yourself as described in the [installation documentation](doc/INSTALL.md). - Compiling the source code yourself as described in the [installation documentation](doc/getting-started/getting-started/installation.md).
### Starting `lightningd` ### Starting `lightningd`
@@ -210,7 +210,7 @@ If you encrypt your `hsm_secret`, you will have to pass the `--encrypted-hsm` st
### Developers ### Developers
Developers wishing to contribute should start with the developer guide [here](doc/HACKING.md). Developers wishing to contribute should start with the developer guide [here](doc/contribute-to-core-lightning/coding-style-guidelines.md).
You should also configure with `--enable-developer` to get additional checks and options. You should also configure with `--enable-developer` to get additional checks and options.
[blockstream-store-blog]: https://blockstream.com/2018/01/16/en-lightning-charge/ [blockstream-store-blog]: https://blockstream.com/2018/01/16/en-lightning-charge/

7
tools/check-markdown.sh
View File

@@ -1,7 +0,0 @@
#!/usr/bin/env bash
if ! diff -u <(grep -E 'sudo apt-get install .*git' README.md) \
<(grep -E 'sudo apt-get install .*git' doc/INSTALL.md); then
echo "Dependencies listed in README.md are not identical to those listed in doc/INSTALL.md (see above). Please fix."
exit 1
fi