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

MDEV-33919: Remove less standard format directive an-trap #3209

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

Conversation

illuusio
Copy link
Contributor

@illuusio illuusio commented Apr 16, 2024

  • The Jira issue number for this PR is: MDEV-33919

Description

Few man pages have less standard format directive: .it 1 an-trap which specifying a formatting instruction related to indentation (adds tab in man page in this)

There is no traces what an-trap should do and removing it does not affect rendering of man page

Release Notes

There should be any mention this on release notes

How can this PR be tested?

One can render these man pages as ascii with

groff -man -Tascii man/mysqlbinlog.1
groff -man -Tascii man/mysqldump.1
groff -man -Tascii man/mysqladmin.1
groff -man -Tascii man/mysqlcheck.1
groff -man -Tascii man/myisamchk.1
groff -man -Tascii man/mysqld_safe.1
groff -man -Tascii man/mysql_upgrade.1

Diff old and new should be the same

Basing the PR against the correct MariaDB version

  • This is a bug fix and the PR is based against the earliest maintained branch in which the bug can be reproduced.

PR quality check

  • I checked the CODING_STANDARDS.md file and my PR conforms to this where appropriate.
  • For any trivial modifications to the PR, I am ok with the reviewer making the changes themselves.

Few man pages have less standard format directive:
.it 1 an-trap which specifying a formatting instruction
related to indentation (adds tab in man page in this)

There is no traces what an-trap should do and removing
it does not affect rendering of man page
@anson1014
Copy link
Contributor

anson1014 commented Apr 23, 2024

Couldn't find too much online regarding the "an-trap" directive. If there's not much documentation on why it is there and there is no functional difference between the output I think it is a good idea to just remove it to avoid confusion.

@illuusio
Copy link
Contributor Author

Couldn't find too much online regarding the "an-trap" directive. If there's not much documentation on why it is there and there is no functional difference between the output I think it is a good idea to just remove it to avoid confusion.

This was kind of my 'motivation'. I could no find any traces why it should be there and it renders the same.

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