Skip to content

Conversation

sommer
Copy link

@sommer sommer commented Dec 8, 2024

Using gitk to view diffs of source code without hard linebreaks is a bit painful without dynamic word wrapping, for which I could not find a preference. The only related one I found was for wrapping the commit subject (called a comment in the source code, I guess), and that did not seem to be reconfigurable in a running gitk.

On the off chance that such features might also be useful to somebody else I am sharing them publicly, as two semi-related changes:

gitk: add text wrapping preferences

Add a new preference "wrapdefault" which allows enabling char/word wrap.
Impacts all text in the ctext widget for which no other preference exists.

Also make the (existing) preference "wrapcomment" configurable graphically.
Its setting impacts only the "comment" part of the ctext widget.

gitk: make headings of preferences bold

Make preference groups like "Diff display options" stand out more.

cc: Johannes Sixt [email protected]

Make preference groups like "Diff display options" stand out more.

Signed-off-by: Christoph Sommer <[email protected]>
Add a new preference "wrapdefault" which allows enabling char/word wrap.
Impacts all text in the ctext widget for which no other preference exists.

Also make the (existing) preference "wrapcomment" configurable graphically.
Its setting impacts only the "comment" part of the ctext widget.

Signed-off-by: Christoph Sommer <[email protected]>
Copy link

gitgitgadget bot commented Dec 8, 2024

Welcome to GitGitGadget

Hi @sommer, 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 <[email protected]>, Ill Takalook <[email protected]>

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 [email protected], 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 gitgitgadget bot added the new user label Dec 8, 2024
@sommer
Copy link
Author

sommer commented Dec 8, 2024

/preview

Copy link

gitgitgadget bot commented Dec 8, 2024

Error: User sommer is not yet permitted to use GitGitGadget

@dscho
Copy link
Member

dscho commented Dec 9, 2024

/allow

Copy link

gitgitgadget bot commented Dec 9, 2024

User sommer is now allowed to use GitGitGadget.

@sommer
Copy link
Author

sommer commented Dec 9, 2024

/submit

Copy link

gitgitgadget bot commented Dec 9, 2024

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1835/sommer/master-v1

To fetch this version to local tag pr-1835/sommer/master-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1835/sommer/master-v1

global NS maxwidth maxgraphpct showneartags showlocalchanges
global tabstop limitdiffs autoselect autosellen extdifftool perfile_attrs
global hideremotes want_ttk have_ttk maxrefs web_browser

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Johannes Sixt wrote (reply to this):

Am 09.12.24 um 19:08 schrieb Christoph Sommer via GitGitGadget:
> From: Christoph Sommer <[email protected]>
> 
> Make preference groups like "Diff display options" stand out more.

This is a nice and obvious improvement.

-- Hannes

Copy link

gitgitgadget bot commented Dec 12, 2024

User Johannes Sixt <[email protected]> has been added to the cc: list.

global tabstop
global findtype findtypemenu findloc findstring fstring geometry
global entries sha1entry sha1string sha1but
global diffcontextstring diffcontext
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Johannes Sixt wrote (reply to this):

Am 09.12.24 um 19:08 schrieb Christoph Sommer via GitGitGadget:
> From: Christoph Sommer <[email protected]>
> 
> Add a new preference "wrapdefault" which allows enabling char/word wrap.
> Impacts all text in the ctext widget for which no other preference exists.
> 
> Also make the (existing) preference "wrapcomment" configurable graphically.
> Its setting impacts only the "comment" part of the ctext widget.

Nice! I agree that it makes sense to wrap the comment differently than
the patch text section. I notice, though, that the patch text wrapping
is also applied to the commit header section. Personally, I don't mind
it. If someone needs a third option, they can take this patch as a
blueprint.

-- Hannes

Copy link

gitgitgadget bot commented Dec 18, 2024

This patch series was integrated into seen via git@904b36b.

Copy link

gitgitgadget bot commented Dec 18, 2024

This patch series was integrated into master via git@904b36b.

Copy link

gitgitgadget bot commented Dec 18, 2024

This patch series was integrated into next via git@904b36b.

Copy link

gitgitgadget bot commented Dec 18, 2024

Closed via 904b36b.

@gitgitgadget gitgitgadget bot closed this Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants