8000 column: exit early when indent length is larger than width by lavendarlatte · Pull Request #1937 · git/git · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

column: exit early when indent length is larger than width #1937

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

column: exit early when indent length is larger than width #1937

wants to merge 1 commit into from
+28 −0

Conversation

lavendarlatte
Copy link
@lavendarlatte lavendarlatte commented Mar 31, 2025 •
edited
Loading

I have sent this to git-security first for potential security check.
Thank you Patrick for review and reply.
Based on your comment I have updated BUG() to die() and added two tests.
Also confirmed all existing column tests pass with new check.

This is copy of his reply:

Hi, thanks for your report!

The use of both print_columns() and run_column_filter() is rather
limited across the Git codebase and only covers across a small set of
builtin commands:

  • git-branch(1), where the value can be changed via the --column
    command line option.
  • git-clean(1), where the values are hardcoded.
  • git-column(1), obviously.
  • git-help(1), but again the values are hardcoded.
  • git-status(1) via wt_longstatus_print_other(), but the values are
    hardcoded.
  • git-tag(1) with the --column command line option.

So only git-branch(1), git-tag(1) and git-column(1) are relevant in this
context, and I cannot think of any way to exploit these in a meaningful
way. I also think that --column options are unlikely to be used in any
scripts.

So all in all I think it's fine to discuss this on our normal mailing
list and fix the issue in the open. But I'd maybe wait a day or two for
others to chime in before doing so.
Given that these values are user-controlled we probably shouldn't use
BUG() because it isn't. die() would likely be a better fit. We
should also have one or two tests to verify that things work as
expected.

CC: Patrick Steinhardt ps@pks.im, gitster@pobox.com, code@khaugsbakk.name

@gitgitgadget-git GitGitGadget-Git
Copy link

Welcome to GitGitGadget

Hi @lavendarlatte, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that either:

  • Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
  • Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
example.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

@gitgitgadget-git GitGitGadget-Git
Copy link

There are issues in commit 52b1cac:
column: exit early when indent length is larger than width
Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
Indented lines, and lines without whitespace, are exempt

@dscho
Copy link
Member
dscho commented Mar 31, 2025

/allow

@dscho
Copy link
Member
dscho commented Mar 31, 2025

@lavendarlatte I took the liberty of deleting the boiler plate text from the PR description, as it would have been sent as part of the cover letter (which is clearly undesirable).

@gitgitgadget-git GitGitGadget-Git
Copy link

User lavendarlatte is now allowed to use GitGitGadget.

WARNING: lavendarlatte has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

@lavendarlatte
column: exit early when indent length is larger than width
9b202b2 
The code exits with "fatal size_t overflow" when indent length is
larger than width. This is because when calculating cols of struct
column_data, unsigned underflow happens and cols is set to negative
value, then converted to size_t when calling REALLOC_ARRAY in
shrink_columns() function. This can lead to allocating extremely
large chunk of memory when succeeds, or crash when fails.

The change exits code early with failure reason to avoid underflow
and clarify argument limitations. This change ensures that cols is
always positive, making the code clearer. It also eliminates the need
for warning suppression related to signed-unsigned comparisons, as
cols can be safely converted to size_t.

Signed-off-by: Hyunji Choi <hyunjidev@gmail.com>
@gitgitgadget-git GitGitGadget-Git
Copy link

Error: Could not determine full name of lavendarlatte

@lavendarlatte
Copy link
Author

/preview
8000

@gitgitgadget-git GitGitGadget-Git
Copy link

Preview email sent as pull.1937.git.git.1743479632864.gitgitgadget@gmail.com

@lavendarlatte
Copy link
Author

/submit

@gitgitgadget-git GitGitGadget-Git
Copy link

Submitted as pull.1937.git.git.1743558315633.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-1937/lavendarlatte/indent-v1

To fetch this version to local tag pr-git-1937/lavendarlatte/indent-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-1937/lavendarlatte/indent-v1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
new user
4594
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lavendarlatte @dscho
0