Add Makefile and refactor scripts to use it. #186
Conversation
googlebot
added
the
cla: yes
Makefile
Outdated
|
|
||
| .PHONY: docs | ||
|
|
||
| PREFIX=/usr/local |
There was a problem hiding this comment.
want to use ?= to let user override? or is this not intended for users?
Makefile
Outdated
| @@ -0,0 +1,72 @@ | |||
| clean: | |||
| rm -rf bazel-* | |||
There was a problem hiding this comment.
This does not actually remove thigns (the bazel-* things are symbolic links to its internal cache).
But bazel clean does.
Makefile
Outdated
|
|
||
| .PHONY: docs | ||
|
|
||
| PREFIX=/usr/local |
There was a problem hiding this comment.
Maybe make PREFIX?=/usr/local ? That way, it can be overridden by an environment variable.
I'd probably put all these variable definitions at the top of the file.
| @true | ||
|
|
||
| # Generate man pages from the tools | ||
| man/verilog_lint.1: bazel-bin/verilog/tools/lint/verilog_lint |
There was a problem hiding this comment.
It would be cool if we could describe these just in a single generic rule (man/%.1 : ...), but unfortunately, these tools have /lint/, /syntax/ and /formatter/ in their path, which makes them escape the common pattern matching rules in make. So I guess no dice.
|
|
||
| man/verilog_format.1: bazel-bin/verilog/tools/formatter/verilog_format | ||
| mkdir -p man | ||
| gflags2man --help_flag="--helpfull" --dest_dir man bazel-bin/verilog/tools/formatter/verilog_format |
There was a problem hiding this comment.
If we submit this, we should then also update the documentation that gflags2man is a requirement for make install
| @@ -0,0 +1,165 @@ | |||
| #!/bin/bash | |||
There was a problem hiding this comment.
Given that this generates docs, I'd rename it go generate-docs.sh
There was a problem hiding this comment.
I think this should probably be a bazel rule in some way?
| # --------------- | ||
| # Generate the GitHub pages to deploy | ||
|
|
||
| TRAVIS_REPO_SLUG=${1:-google/verible} |
There was a problem hiding this comment.
This is a confusingly named variable. For the perspective of the user of this script, who has this in their toplevel checked out repo, everything runs locally and nothing has to to with travis.
The travis repo is just the github path ? So this variable should probably be name GITHUB_PATH.
Also looking at all the uses below, it is always assembled together with the full URL, so couldn't we just have
GITHUB_BASE_URL=https://github.com/google/verible
and use that below ? (but I suspect you want to set something in travis that utilizes this variable in a different way)
|
Any update ? This would be great to have! |
- `make clean` - `make build` - `make docs` - `make tools` - `make install` Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
| # Generate man pages from the tools | ||
| man/verilog_lint.1: bazel-bin/verilog/tools/lint/verilog_lint | ||
| mkdir -p man | ||
| gflags2man --help_flag="--helpfull" --dest_dir man bazel-bin/verilog/tools/lint/verilog_lint |
There was a problem hiding this comment.
@hzeller - I think the gfags2man stuff should probably be a bazel rule?
This could simplifiy #186 PiperOrigin-RevId: 296482842
|
There is now a BUT, unlike a usual 'make ; sudo make install', bazel shall not be run as root, but we choose with the This is somewhat different how a |
|
@hzeller is going to figure out how to make the documentation generation and the man page generation into bazel rules. This Makefile will then just become a simple tool for those too lazy to remember the bazel commands. |
|
Assigning to @hzeller to take over. |
Can be used in #186 PiperOrigin-RevId: 296521780
|
Cleaning out old pull requests. Ideas of this have been implemented in various ways. |
make cleanmake buildmake docsmake toolsmake installSigned-off-by: Tim 'mithro' Ansell me@mith.ro