From 705b7e2d361b10caa5effc086773f9a47099b2ab Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Tue, 16 May 2023 13:08:43 -0400 Subject: [PATCH] comment --- ..._3a2fe8d0c0dd6f5066370086c0f03300._comment | 32 +++++++++++++++++++ ..._2e0ad0cdb9d813d0fbc514c1642669ca._comment | 14 ++++++++ 2 files changed, 46 insertions(+) create mode 100644 doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_5_3a2fe8d0c0dd6f5066370086c0f03300._comment create mode 100644 doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_6_2e0ad0cdb9d813d0fbc514c1642669ca._comment diff --git a/doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_5_3a2fe8d0c0dd6f5066370086c0f03300._comment b/doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_5_3a2fe8d0c0dd6f5066370086c0f03300._comment new file mode 100644 index 0000000000..559780738f --- /dev/null +++ b/doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_5_3a2fe8d0c0dd6f5066370086c0f03300._comment @@ -0,0 +1,32 @@ +[[!comment format=mdwn + username="joey" + subject="""comment 5""" + date="2023-05-16T16:32:51Z" + content=""" +sync's intent is to replicate as close as possible the following common +git workflow: + + first stage some changes, and then run: + git commit -m foo + git pull + git push + +Since git-annex has some complications involving pulling and pushing +the git-annex branch, and transferring the content, it adds a learning +curve that was too high. Giving users one new command to learn minimizes +the learning curve. (It's unfortunate it didn't originally send content, +and annex.synccontent aims to fix that oversight and I hope it may eventually +become default.) + +For git-annex sync to default to doing something not in the above +pull+commit+push workflow would be surprising, because that's the workflow +users have been told it handles. + +Notice that the git-annex assistant will happily add all files to the +repository and send their content. That's because it's *not* targeting +users who expect to use that git workflow. So it's not surprising that it +does what it does. + +In conclusion, if having this behavior enabled by git config is not useful, +then it does not belong in `git-annex sync`. It could go in a new command. +"""]] diff --git a/doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_6_2e0ad0cdb9d813d0fbc514c1642669ca._comment b/doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_6_2e0ad0cdb9d813d0fbc514c1642669ca._comment new file mode 100644 index 0000000000..d70ab6ef04 --- /dev/null +++ b/doc/todo/Having___39__git_annex_sync__39___optionally_add/comment_6_2e0ad0cdb9d813d0fbc514c1642669ca._comment @@ -0,0 +1,14 @@ +[[!comment format=mdwn + username="joey" + subject="""comment 6""" + date="2023-05-16T17:05:35Z" + content=""" +I also generally feel like `git-annex sync` was probably a bad conflation +of 3 git commands into 1 command when there could have just been `git-annex +pull` and `git-annex push`. The fact that it conflates several things makes +users think of it as just a big "does all the things" command, which makes +users want it to do more things. + +It is not too late to split it up, and eventually deprecating it would be a +good path to making annex.synccontent default. +"""]] -- 2.30.2