forked from TrueCloudLab/frostfs-api
Fix typos in Makefile and READMEs
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
parent
e36c9228e3
commit
28a917028d
2 changed files with 4 additions and 6 deletions
4
Makefile
4
Makefile
|
@ -10,10 +10,10 @@ lint:
|
||||||
buf check breaking --against-input '.git#branch=$(BRBR)'
|
buf check breaking --against-input '.git#branch=$(BRBR)'
|
||||||
|
|
||||||
.PHONY: doc
|
.PHONY: doc
|
||||||
# Regenerate documentation for protot files:
|
# Regenerate documentation for proto files:
|
||||||
doc:
|
doc:
|
||||||
@for f in `find . -type f -name '*.proto' -exec dirname {} \; | sort -u `; do \
|
@for f in `find . -type f -name '*.proto' -exec dirname {} \; | sort -u `; do \
|
||||||
echo "${B}${G}⇒ Documentation for $$(basename $$f) ${R}"; \
|
echo "⇒ Documentation for $$(basename $$f)"; \
|
||||||
protoc \
|
protoc \
|
||||||
--doc_opt=.github/markdown.tmpl,$${f}.md \
|
--doc_opt=.github/markdown.tmpl,$${f}.md \
|
||||||
--proto_path=.:/usr/local/include \
|
--proto_path=.:/usr/local/include \
|
||||||
|
|
|
@ -25,7 +25,7 @@ This repository contains:
|
||||||
- [auto-generated docs](proto-docs) for protocol buffers
|
- [auto-generated docs](proto-docs) for protocol buffers
|
||||||
- [manually written docs](docs) for developers (to be done)
|
- [manually written docs](docs) for developers (to be done)
|
||||||
|
|
||||||
# Contributing
|
## Contributing
|
||||||
|
|
||||||
Feel free to contribute to this project after reading the [contributing
|
Feel free to contribute to this project after reading the [contributing
|
||||||
guidelines](CONTRIBUTING.md).
|
guidelines](CONTRIBUTING.md).
|
||||||
|
@ -33,9 +33,7 @@ guidelines](CONTRIBUTING.md).
|
||||||
Before starting to work on a certain topic, create an new issue first,
|
Before starting to work on a certain topic, create an new issue first,
|
||||||
describing the feature/topic you are going to implement.
|
describing the feature/topic you are going to implement.
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the Apache 2.0 License -
|
This project is licensed under the Apache 2.0 License -
|
||||||
see the [LICENSE](LICENSE) file for details
|
see the [LICENSE](LICENSE) file for details
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue