Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SKARA-1194: Implement git webrev --no-comments option #1224

Closed

Conversation

shipilev
Copy link
Contributor

@shipilev shipilev commented Sep 28, 2021

hg webrev had a -C / --no-comments option that skipped printing the comments for each file, i.e. commit messages. GitWebrev accepts the same option, but it does not seem to be implemented. Producing a webrev for a branch with a lot of commits looks badly then.

For example, current report with -C:

 ------ ------ ------ ------ --- New Patch Raw doc/panama_jextract.html

    8065b5cc: 8270898: update panama_jextract.md and panama_jextract.html files
    bedc58a3: 8257892: long double not handled by jextract
    2d966367: Consolidate all the various documents in the repository.
    3dc23ea0: 8253419: jextract should generate RuntimeHelper as a package private class
    52adf7f5: updating samples for CSupport->CLinker
    33cba7a0: adding tensorflow sample
    06675b1e: updating samples. changed constants class to use package constructor
    6809ef51: Samples update after 8249879. Added opengl sample
    abb6e377: updating samples for recent MemoryAccess changes.
    ebba5406: 8248710: jextract should not generate Cstring, Cpointer, Cint C-X utility classes
    45d41d75: * Fixed include path to be OS/SDK version independent
    ...

    992 lines changed; 992 ins; 0 del; 0 mod; 0 unchg

Fixed report with -C:

 ------ ------ ------ ------ --- New Patch Raw doc/panama_jextract.html

    992 lines changed; 992 ins; 0 del; 0 mod; 0 unchg 

Additional testing:

  • Eyeballing the reports with/without -C

Progress

  • Change must not contain extraneous whitespace
  • Change must be properly reviewed

Issue

  • SKARA-1194: Implement git webrev --no-comments option

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/skara pull/1224/head:pull/1224
$ git checkout pull/1224

Update a local copy of the PR:
$ git checkout pull/1224
$ git pull https://git.openjdk.java.net/skara pull/1224/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1224

View PR using the GUI difftool:
$ git pr show -t 1224

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/skara/pull/1224.diff

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Sep 28, 2021

👋 Welcome back shade! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr label Sep 28, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Sep 28, 2021

Webrevs

Copy link
Member

@erikj79 erikj79 left a comment

It's unfortunate to have a field/variable with a negation in the name, but in this case it matches the argument so it could be ok. Maybe worth inverting the internal variable/field? What do you think? I'm approving this as it is if you don't want to.

@openjdk
Copy link

@openjdk openjdk bot commented Sep 28, 2021

@shipilev This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

🔍 One or more changes in this pull request modifies files in areas of the source code that often require two reviewers. Please consider if this is the case for this pull request, and if so, await a second reviewer to approve this pull request before you integrate it.

After integration, the commit message for the final commit will be:

1194: Implement git webrev --no-comments option

Reviewed-by: erikj, ihse

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@erikj79, @magicus) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added the ready label Sep 28, 2021
@shipilev
Copy link
Contributor Author

@shipilev shipilev commented Sep 29, 2021

It's unfortunate to have a field/variable with a negation in the name, but in this case it matches the argument so it could be ok. Maybe worth inverting the internal variable/field? What do you think? I'm approving this as it is if you don't want to.

OK, we can drop "no" from field names and negate it when reading from cli. See new commit.

Copy link
Member

@erikj79 erikj79 left a comment

Looks good! Thanks for contributing to Skara!

@shipilev
Copy link
Contributor Author

@shipilev shipilev commented Sep 29, 2021

Thanks!

/integrate

@openjdk openjdk bot added the sponsor label Sep 29, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Sep 29, 2021

@shipilev
Your change (at version c5ea0f2) is now ready to be sponsored by a Committer.

@magicus
Copy link
Member

@magicus magicus commented Sep 30, 2021

/sponsor

@openjdk
Copy link

@openjdk openjdk bot commented Sep 30, 2021

Going to push as commit 68872aa.

@openjdk openjdk bot closed this Sep 30, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Sep 30, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Sep 30, 2021

@magicus @shipilev Pushed as commit 68872aa.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@openjdk openjdk bot removed the sponsor label Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants