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

docs: list supported and unsupported Git features #119

Merged
merged 4 commits into from
Mar 12, 2022
Merged

docs: list supported and unsupported Git features #119

merged 4 commits into from
Mar 12, 2022

Conversation

martinvonz
Copy link
Member

No description provided.

Copy link
Contributor

@arxanas arxanas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other topics you might want to mention, in some order:

  • Merge commits (and maybe octopus merges?).
  • Rebasing. (Maybe also commit deduplication as a part of rebasing? If a commit is merged into the main branch upstream, can you rebase on top on of it and skip the appropriate commit?)
  • Orphan branches/unborn HEAD.
  • Detached HEAD.
  • Whether there's a reflog-like strucure. (Maybe the operation log is a superior replacement?)
  • The staging area/partial commits. Obviously one of the features is that there's no more staging area, so you might want to explain how to achieve equivalent workflows for partial commits or moving changes across branches.
  • Whether jj can be used with a bare Git repository backing it.
  • Garbage collection/what kind of objects are cleaned up, if any.
  • Object packing (both whether you can save disk space and whether jj will incur periodic repacking pauses, or perhaps whether jj generates a lot of object churn).

docs/git-compatibility.md Outdated Show resolved Hide resolved
@martinvonz martinvonz force-pushed the docs branch 3 times, most recently from a45b6ac to 26000fc Compare March 10, 2022 15:46
docs/git-compatibility.md Outdated Show resolved Hide resolved
@martinvonz martinvonz force-pushed the docs branch 2 times, most recently from 060a0ca to 41281b3 Compare March 10, 2022 20:41
@spoerri
Copy link

spoerri commented Mar 11, 2022

Might want to mention cherry picking

@martinvonz
Copy link
Member Author

Might want to mention cherry picking

For my understanding, what do you think I should say about it?

I ask because I think it's more relevant in https://github.com/martinvonz/jj/blob/main/docs/git-comparison.md (which I need to expand quite a bit). There I could explain how to achieve cherry-picking with jj. It could also make sense to mention in this doc how jj behaves after you do a git cherry-pick. So I think it could be documented in both places.

@spoerri
Copy link

spoerri commented Mar 11, 2022

more relevant in https://github.com/martinvonz/jj/blob/main/docs/git-comparison.md

OK, I guess this page could be more about which git repo features are supported.

how to achieve cherry-picking with jj

That'd be great, thank you

@martinvonz
Copy link
Member Author

more relevant in https://github.com/martinvonz/jj/blob/main/docs/git-comparison.md

OK, I guess this page could be more about which git repo features are supported.

Exactly, that was my intent anyway. I'll try to fill in git-comparison.md soon. Perhaps it turns out to be too unclear what the difference between the two docs is and I'll have to merge them or restructure, but for now I'll continue writing them as two separate docs.

how to achieve cherry-picking with jj

That'd be great, thank you

I've added that to this PR.

@martinvonz
Copy link
Member Author

I've updated git-comparison.md as well now. Please take a look if you have time.

Copy link
Contributor

@arxanas arxanas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good on my end. You might want to bold the subject for each bullet point to make it easier to skim through.

@martinvonz
Copy link
Member Author

Looks good on my end.

Thanks for reviewing.

You might want to bold the subject for each bullet point to make it easier to skim through.

That seems like a good idea. I've updated both git-compatibility.md and git-comparison.md.

@martinvonz martinvonz merged commit 6902c70 into main Mar 12, 2022
@martinvonz martinvonz deleted the docs branch March 12, 2022 06:47
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

Successfully merging this pull request may close these issues.

3 participants