From ec42220e7773fba548e379606fe445cb30f4c424 Mon Sep 17 00:00:00 2001 From: Dmitry Vyukov Date: Wed, 29 Apr 2020 17:57:32 +0200 Subject: Makefile: generate descriptions on-the-fly Checking in the generated descriptions files makes few things simpler, but causes pain for pull requests: (1) PRs that touch descriptions _always_ conflict, (2) PRs are large and harder to review, (3) people sometimes forget to add auto-generated files. The proposed way does not require us to hardcode lots of dependencies in the Makefile (which is nice) and seem to work. Let's see how it works. The main contributor-visible consequence is that the auto-generated files do not need to be checked-in now. Credit for figuring the Makefile magic goes to @melver. Fixes #1291 --- docs/contributing.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'docs/contributing.md') diff --git a/docs/contributing.md b/docs/contributing.md index a701e6682..9e3a14dd3 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -30,10 +30,9 @@ Also: (where `NNN` is issue number). This will auto-close the issue. If you need to mention an issue without closing it, add `Update #NNN`. - The pull request text is mostly irrelevant. -- Run `make presubmit` and ensure that it passes before sending a PR. It may require some additional packages to be installed (try `sudo make install_prerequisites`). -- _All_ generated files (`*.const`, `*.go`, `*.h`) are checked-in with the -`*.txt` changes in the same commit. Namely, `make generate` must not produce -_any_ diff in the tree. +- Run `make presubmit` and ensure that it passes before sending a PR. + It may require some additional packages to be installed (try `sudo make install_prerequisites`). +- `*.const` files are checked-in with the `*.txt` changes in the same commit. - Rebase your pull request onto the master branch before submitting. - If you're asked to add some fixes to your pull requested, please squash the new commits with the old ones. -- cgit mrf-deployment