Skip to content

Commit

Permalink
Update other documentation files
Browse files Browse the repository at this point in the history
  • Loading branch information
kpitt committed Sep 27, 2022
1 parent e9cfb29 commit e6cdca0
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 7 deletions.
1 change: 0 additions & 1 deletion docs/backends.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ the context handlers in the same package.

* [fs](backends/fs.md) - Filesystem storage without RCS support
* [gitfs](backends/gitfs.md) - Filesystem storage with Git RCS
* [fossilfs] - Filesystem storage with Fossil RCS. **Highly experimental, likely broken**. Use only if you want to contributed to the backend.

## Crypto Backends (crypto)

Expand Down
2 changes: 0 additions & 2 deletions docs/commands/convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ Note: This command exists to enable a possible migration path. If we agree
on a single set of backend implementations the multiple backend support
might go away and this command as well.

Warning: Converting between different RCS backends will loose part of the history. While we try to retain as much information as possible especially the commit timestamps will be set to the convert time.

## Synopsis

```
Expand Down
3 changes: 1 addition & 2 deletions docs/commands/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ TODO: We need to specify the expectations around new lines.
* The `--clip` flag will copy the value of the `Password` field to the clipboard and doesn't display any part of the secret.
* The `--alsoclip` option will copy the value of the `Password` field but also display the secret content depending on the `safecontent` setting, i.e. obstructing the `Password` field if `safecontent` is `true` or just displaying it if not.
* The `--qr` flags operates complementary to other flags. It will *additionally* format the value of the `Password` entry as a QR code and display it. Other than that it will honor the other options, e.g. `gopass show --qr` will display the QR code *and* the whole secret content below. One special case is the `-o` flag, this flag doesn't make a lot of sense in combination, so if both `--qr` and `-o` are given only the QR code will be displayed.
* Since gopass plans to supports different RCS backends we do not support arbitrary git refs as arguments to the `--revision` flag. Using those might work, but this is explicitly not supported and bug reports will be closed as `wont-fix`. There are two issues with using arbitrary git refs is that (a) this doesn't work with non-git RCS backends and (b) git versions a whole repository, not single files. So the revision `HEAD^`
might not have any changes for a given entry. Thus we only support specifc revisions obtained from `gopass history` or our custom syntax `-N` where N is an integer identifying a specific commit before `HEAD` (cf. `HEAD~N`).
* Arbitrary git refs are not supported as arguments to the `--revision` flag. Using those might work, but this is explicitly not supported and bug reports will be closed as `wont-fix`. The main issue with using arbitrary git refs is that git versions a whole repository, not single files. So the revision `HEAD^` might not have any changes for a given entry. Thus we only support specifc revisions obtained from `gopass history` or our custom syntax `-N` where N is an integer identifying a specific commit before `HEAD` (cf. `HEAD~N`).

## Parsing and secrets

Expand Down
4 changes: 2 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Variables not exclusively used by gopass
| `PASSWORD_STORE_UMASK` | `string` | Set to any valid umask to mask bits of files created by gopass (GOPASS_UMASK has precedence over this) |
| `EDITOR` | `string` | command name to execute for editing password entries |
| `PAGER` | `string` | the pager program used for `gopass list`. See [Features](features.md#auto-pager) for details |
| `GIT_AUTHOR_NAME` | `string` | name of the author, used by the rcs backend to create a commit |
| `GIT_AUTHOR_EMAIL` | `string` | email of the author, used by the rcs backend to create a commit |
| `GIT_AUTHOR_NAME` | `string` | name of the author, used by the git backend to create a commit |
| `GIT_AUTHOR_EMAIL` | `string` | email of the author, used by the git backend to create a commit |
| `NO_COLOR` | `bool` | disable color output. See [no-color.org](https://no-color.org) for more information. |

## Configuration Options
Expand Down

0 comments on commit e6cdca0

Please sign in to comment.