Skip to content

Commit

Permalink
[website] misc. minor improvements
Browse files Browse the repository at this point in the history
Summary:
- rename the checker "Uninitialized Variable" to "Uninitialized Value"
  as this is the name of the issue type
- delete timestamp XML comment from the man pages to avoid future git
  churn when updating the website
- counting is hard

Reviewed By: martintrojer

Differential Revision: D24219165

fbshipit-source-id: cf3057373
  • Loading branch information
jvillard authored and facebook-github-bot committed Oct 9, 2020
1 parent cce1934 commit 79c6cd3
Show file tree
Hide file tree
Showing 25 changed files with 8 additions and 26 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/install.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ jobs:
4. Download the release tarballs and test that the binaries works.
5. Fill in the shasums by running the command at the end of the release text.
--- PUBLISH GITHUB RELEASE HERE ---
5. At some point, copy the GitHub changelog to Changelog.md in the repo.
6. Tweet.
6. At some point, copy the GitHub changelog to Changelog.md in the repo.
7. Tweet.
--- DELETE EVERYTHING ABOVE THIS LINE ---
This is a binary release of Infer for Linux and MacOS. To use it follow these [instructions](http://fbinfer.com/docs/getting-started.html).
Expand Down
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -915,7 +915,9 @@ endif
$(QUIET)$(call silent_on_success,Copying man pages,\
$(REMOVE) "$(WEBSITE_DIR)"/static/man/*; \
for man in $(INFER_GROFF_MANUALS); do \
groff -Thtml "$$man" > "$(WEBSITE_DIR)"/static/man/next/$$(basename "$$man").html; \
groff -Thtml "$$man" \
| grep -v '^<!-- CreationDate: .*>$$' \
> "$(WEBSITE_DIR)"/static/man/next/$$(basename "$$man").html; \
done)
$(QUIET)$(call silent_on_success,Building OCaml modules documentation,\
$(MAKE) IS_FACEBOOK_TREE=no NO_BROWSE_DOC=yes doc)
Expand Down
2 changes: 1 addition & 1 deletion infer/src/base/Checker.ml
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ let config_unsafe checker =
; activates= [Pulse] }
| Uninit ->
{ id= "uninit"
; kind= UserFacing {title= "Uninitialized Variable"; markdown_body= ""}
; kind= UserFacing {title= "Uninitialized Value"; markdown_body= ""}
; support= supports_clang
; short_documentation= "Warns when values are used before having been initialized."
; cli_flags= Some {deprecated= []; show_in_help= true}
Expand Down
2 changes: 1 addition & 1 deletion website/docs/checker-uninit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Uninitialized Variable"
title: "Uninitialized Value"
description: "Warns when values are used before having been initialized."
---

Expand Down
1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-analyze.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-capture.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-compile.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-debug.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-explore.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-help.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-report.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-reportdiff.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer-run.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/1.0.0/infer.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-analyze.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-capture.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-compile.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-debug.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-explore.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-help.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-report.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-reportdiff.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer-run.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion website/static/man/next/infer.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion website/versioned_docs/version-1.0.0/checker-uninit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Uninitialized Variable"
title: "Uninitialized Value"
description: "Warns when values are used before having been initialized."
---

Expand Down

0 comments on commit 79c6cd3

Please sign in to comment.