test1234
/
gitea
forked from gitea/gitea
1
0
Fork 0
Code Pull Requests Activity

Generate man pages (#13901) 

* extend gitignore

* first working draft

* use docs subcomand

* rm config-sheet-sheet-2-man
This commit is contained in:
6543 2021-02-24 23:36:48 +01:00 committed by GitHub
parent 61f347e349
commit 5cc1a49b19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -106,3 +106,6 @@ prime/
# Make evidence files # Make evidence files
/.make_evidence /.make_evidence
# Manpage
/man

11
Makefile
View File

@ -178,6 +178,7 @@ help:
@echo " - fmt format the Go code" @echo " - fmt format the Go code"
@echo " - generate-license update license files" @echo " - generate-license update license files"
@echo " - generate-gitignore update gitignore files" @echo " - generate-gitignore update gitignore files"
@echo " - generate-manpage generate manpage"
@echo " - generate-swagger generate the swagger spec from code comments" @echo " - generate-swagger generate the swagger spec from code comments"
@echo " - swagger-validate check if the swagger spec is valid" @echo " - swagger-validate check if the swagger spec is valid"
@echo " - golangci-lint run golangci-lint linter" @echo " - golangci-lint run golangci-lint linter"
@ -223,7 +224,7 @@ clean:
integrations*.test \ integrations*.test \
integrations/gitea-integration-pgsql/ integrations/gitea-integration-mysql/ integrations/gitea-integration-mysql8/ integrations/gitea-integration-sqlite/ \ integrations/gitea-integration-pgsql/ integrations/gitea-integration-mysql/ integrations/gitea-integration-mysql8/ integrations/gitea-integration-sqlite/ \
integrations/gitea-integration-mssql/ integrations/indexers-mysql/ integrations/indexers-mysql8/ integrations/indexers-pgsql integrations/indexers-sqlite \ integrations/gitea-integration-mssql/ integrations/indexers-mysql/ integrations/indexers-mysql8/ integrations/indexers-pgsql integrations/indexers-sqlite \
integrations/indexers-mssql integrations/mysql.ini integrations/mysql8.ini integrations/pgsql.ini integrations/mssql.ini integrations/indexers-mssql integrations/mysql.ini integrations/mysql8.ini integrations/pgsql.ini integrations/mssql.ini man/
.PHONY: fmt .PHONY: fmt
fmt: fmt:
@ -702,6 +703,14 @@ generate-images:
npm install --no-save --no-package-lock fabric imagemin-zopfli npm install --no-save --no-package-lock fabric imagemin-zopfli
node build/generate-images.js $(TAGS) node build/generate-images.js $(TAGS)
.PHONY: generate-manpage
generate-manpage:
@[ -f gitea ] || make backend
@mkdir -p man/man1/ man/man5
@./gitea docs --man > man/man1/gitea.1
@gzip -9 man/man1/gitea.1 && echo man/man1/gitea.1.gz created
@#TODO A smal script witch format config-cheat-sheet.en-us.md nicely to suit as config man page
.PHONY: pr\#% .PHONY: pr\#%
pr\#%: clean-all pr\#%: clean-all
$(GO) run contrib/pr/checkout.go $* $(GO) run contrib/pr/checkout.go $*