Skip to content

Split long lines exceeding 512 characters in docs and i18n #4500

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

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

Conversation

jmkim
Copy link
Contributor

@jmkim jmkim commented Apr 22, 2025

PR Description

This PR is related to the Debian packaging.

It fixes the Lintian tag very-long-line-length-in-source-file, by splitting lines that exceed 512 characters. We can view current Lintian complaints here.

Lintian is the Debian package checker used to verify binary and source packages for Debian Policy compliance and common packaging issues.

Affected files

  • Documentation
    • README.md: Split badge and sponsor sections
    • Simple line splits in:
      • CONTRIBUTING.md
      • docs/Custom_Command_Keybindings.md
      • docs/dev/Busy.md
      • docs/dev/Codebase_Guide.md
      • pkg/integration/README.md
  • Code
    • pkg/i18n/english.go: Split a long string literal using +

Requirements fulfilled by this PR

  • Cheatsheets are up-to-date (run go generate ./...)
  • Code has been formatted (see here)
  • Docs have been updated if necessary
  • You've read through your own file changes for silly mistakes etc

Fix Lintian (Debian package checker) tag: very-long-line-length-in-source-file
https://udd.debian.org/lintian-tag/very-long-line-length-in-source-file

Signed-off-by: Jongmin Kim <jmkim@debian.org>
@jmkim
Copy link
Contributor Author

jmkim commented Apr 22, 2025

It seems that the sponsors section is regularly updated by GitHub Actions[bot].

If we decide to apply this PR, we should update it accordingly (e.g. by adding a newline character between <a> tags).

@jesseduffield
Copy link
Owner

What is the worst case scenario if we just ignore the debian linter error?

@jmkim
Copy link
Contributor Author

jmkim commented Apr 23, 2025

Thank you for addressing this issue.

Although this is not a direct bug in lazygit itself (which is why I mentioned it is related to Debian packaging),

Some tools (e.g. sed, grep, or lintian itself) may misbehave or fail when processing extremely long lines, especially on constrained environments or older build systems. This can lead to FTBFS "Fails To Build From Source" bugs during the Debian package build.

Lintian assumes that Debian build systems can safely handle lines up to 512 characters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants