Amend author and committer docs#2826
Conversation
There was a problem hiding this comment.
This file is automatically generated using --help output of each command. I don't remember the process for making this happen, but if you want these docs updates, you need to change the help output of the command itself.
There was a problem hiding this comment.
This file is generated using dolt dump-docs
| | parents | text | -- column hidden unless `--parents` flag provided | ||
| | refs | text | -- column hidden unless `--decorate` is "short" or "full" | ||
| +--------------+--------- + | ||
| | signature | text | -- column hidden unless `--show-signature` flag provided |
There was a problem hiding this comment.
ugh, so if the index of the author, author_email and author_date columns will change based on the existence of the --show-signature, --parents and --decorate flags?? I missed that fact in the review. I think that we should revisit this - probably just list them all always. This may be worth discussion in the dolt channel.
| `--date`: Specify the date used in the commit. If not specified, the current system time is used. | ||
|
|
||
| `--author`: Specify an explicit author using the standard "A U Thor author@example.com" format. Note that unlike `dolt commit` on the CLI, when invoking the `dolt_commit()` stored procedure, the default commit author is the authenticated SQL user (e.g. `root@localhost`). | ||
| `--author`: Specify an explicit author using the standard "A U Thor author@example.com" format. Note that unlike `dolt commit` on the CLI, when invoking the `dolt_commit()` stored procedure, the default commit author is the authenticated SQL user (e.g. `root@localhost`). See [commit identity variables](dolt-sysvars.md#commit-identity-variables) to override identity per session. |
There was a problem hiding this comment.
I realize now that you didn't add a --committer flag like we discussed. It's only possible using the session var. Not ideal. We can add in the future
3 participants
Fix dolthub/dolt#1374
Blocked by dolthub/dolt#10104