lsd-rs / lsd

The next gen ls command
Apache License 2.0
12.85k stars 420 forks source link

Remove `literal` and `truncate-owner` fields from example readme #1005

Closed olgabot closed 3 months ago

olgabot commented 4 months ago

Hello, In setting up my lsd configuration, I ran into some issues that both the literal and truncate-owner fields weren't supported in lsd version 1.0.0. This commit removes those fields from the example README for future users. Hope that helps! Warmest, Olga

(base)
 Thu  7 Mar - 10:43  ~ 
  lsd --version
lsd 1.0.0

Here are the error messages:

(base)
 Thu  7 Mar - 10:42  ~ 
  lsd --config-file ~/.config/lsd/config.yml
lsd: Configuration file /Users/olgabotvinnik/.config/lsd/config.yml format error, unknown field `literal`, expected one of `classic`, `blocks`, `color`, `date`, `dereference`, `display`, `icons`, `ignore-globs`, `indicators`, `layout`, `recursion`, `size`, `permission`, `sorting`, `no-symlink`, `total-size`, `symlink-arrow`, `hyperlink`, `header` at line 141 column 1.

thread 'main' panicked at /Users/olgabotvinnik/.cargo/registry/src/index.crates.io-6f17d22bba15001f/lsd-1.0.0/src/main.rs:117:33:
Provided file path is invalid
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
(base)
 ✘  Thu  7 Mar - 10:42  ~ 
  lsd --config-file ~/.config/lsd/config.yml
lsd: Configuration file /Users/olgabotvinnik/.config/lsd/config.yml format error, unknown field `truncate-owner`, expected one of `classic`, `blocks`, `color`, `date`, `dereference`, `display`, `icons`, `ignore-globs`, `indicators`, `layout`, `recursion`, `size`, `permission`, `sorting`, `no-symlink`, `total-size`, `symlink-arrow`, `hyperlink`, `header` at line 146 column 1.

thread 'main' panicked at /Users/olgabotvinnik/.cargo/registry/src/index.crates.io-6f17d22bba15001f/lsd-1.0.0/src/main.rs:117:33:
Provided file path is invalid
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

TODO

muniu-bot[bot] commented 4 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: olgabot

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/lsd-rs/lsd/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
zwpaper commented 3 months ago

Hi @olgabot, the master docs is for the development version, and the config should be available as we now released a newer version.

please check the tag for specific version docs.

also we are planning a doc site to fix these versioned docs problems, please check https://github.com/lsd-rs/lsd/issues/988

still thanks for the contribution!

/close

muniu-bot[bot] commented 3 months ago

@zwpaper: You can't close an active issue/PR unless you authored it or you are a collaborator.

In response to [this](https://github.com/lsd-rs/lsd/pull/1005#issuecomment-2018391480): >Hi @olgabot, the master docs is for the development version, and the config should be available as we now released a newer version. > >please check the tag for specific version docs. > >also we are planning a doc site to fix these versioned docs problems, please check https://github.com/lsd-rs/lsd/issues/988 > >still thanks for the contribution! > >/close > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.