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

options.history in the documentation is confusing to understand #426

Open
rodet opened this issue Apr 21, 2022 · 0 comments
Open

options.history in the documentation is confusing to understand #426

rodet opened this issue Apr 21, 2022 · 0 comments

Comments

@rodet
Copy link

rodet commented Apr 21, 2022

This is how it looks like at the moment:

image

Reading this, I can't be sure if the history is kept or not when this is set to true. I'm also not sure what the example does: keep or erase the history? A very short clarification would be super useful, ie "setting this option to true (or false?) will cause a force push that will discard the previous history. You might use it to save space in your repository in case the branch content is the output from a build process".

As a good example, I find the command line help clearer:

-f, --no-history Push force new commit without parent history

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

No branches or pull requests

1 participant