Bug 276556 - [patch] add CLICOLOR to --color=auto description in ls(1)
Summary: [patch] add CLICOLOR to --color=auto description in ls(1)
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Gordon Bergling
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-01-23 15:18 UTC by Stefan Schlosser
Modified: 2024-02-28 12:49 UTC (History)
2 users (show)

See Also:


Attachments
add CLICOLOR to description (743 bytes, patch)
2024-01-23 15:18 UTC, Stefan Schlosser
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Stefan Schlosser 2024-01-23 15:18:40 UTC
Created attachment 247891 [details]
add CLICOLOR to description

Manpage ls(1) lists CLICOLOR in option -G:

-G      Enable colorized output.  This option is equivalent to defining
        CLICOLOR or COLORTERM in the environment and setting
        --color=auto.  (See below.)  This functionality can be compiled
        out by removing the definition of COLORLS.  This option is not
        defined in IEEE Std 1003.1-2008 (“POSIX.1”).

But CLICOLOR is missing in --color=auto description:

        auto will make ls output escape sequences based on termcap(5),
        but only if stdout is a tty and either the -G flag is specified
        or the COLORTERM environment variable is set and not empty.

Patch adds CLICOLOR to description.
Comment 1 commit-hook freebsd_committer freebsd_triage 2024-02-21 10:56:00 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=ffea732c5192070a6877409428b0a2cc1728aa16

commit ffea732c5192070a6877409428b0a2cc1728aa16
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2024-02-21 10:54:58 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2024-02-21 10:54:58 +0000

    ls.1: Mention CLICOLOR environment variable

    Mention CLICOLOR environment variable in the manual page.

    PR:     276556
    Submitted by:   bsdcode at disroot dot org
    Reviewed by:    imp
    MFC after:      3 days
    Differential Revision:  https://reviews.freebsd.org/D43970

 bin/ls/ls.1 | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
Comment 2 Gordon Bergling freebsd_committer freebsd_triage 2024-02-21 10:58:15 UTC
Committed, thanks for the patch.


To commit the patch in "your name", it would be good if you could summit a patch with a real name to not mess up with commit logs.

I have seen, that you have more patches summited, it would be great if you could submit a comment with the relevant information. I take care of the rest.
Comment 3 Stefan Schlosser 2024-02-21 14:26:49 UTC
I can provide new patches with my real name, the e-mail stays the same.

Should I re-submit the patches for all my opened PRs with the changed username (except this PR I suppose?).
Comment 4 Gordon Bergling freebsd_committer freebsd_triage 2024-02-27 17:26:58 UTC
(In reply to Stefan Schlosser from comment #3)
No, you don't have to resubmit your patches. I'll commit them once approved with your real name and e-mail address provided. For this PR I am still waiting for an approval by @imp, because there are some ls(1) updates including the manual page, that aren't in stable/14 or stable/13. Once I have the approval the MFC these changes first, I can MFC your patch to stable branches and close the PR.

Besides this, thanks for the patches.
Comment 5 commit-hook freebsd_committer freebsd_triage 2024-02-28 12:49:19 UTC
A commit in branch stable/14 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=d19769300126426cc59b83036d3ba3e3d8425c16

commit d19769300126426cc59b83036d3ba3e3d8425c16
Author:     Gordon Bergling <gbe@FreeBSD.org>
AuthorDate: 2024-02-21 10:54:58 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2024-02-28 12:48:42 +0000

    ls.1: Mention CLICOLOR environment variable

    Mention CLICOLOR environment variable in the manual page.

    PR:     276556
    Submitted by:   bsdcode at disroot dot org
    Reviewed by:    imp
    Differential Revision:  https://reviews.freebsd.org/D43970

    (cherry picked from commit ffea732c5192070a6877409428b0a2cc1728aa16)

 bin/ls/ls.1 | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)