pr-1148/newren/sparse-checkout-default-v2
tagged this
12 Mar 03:11
== Updates Log == Changes since v1: * rebased on master, to remove dependence on en/present-despite-skipped (which has since merged to master). Earlier version of series wasn't picked up anyway, so rebasing should be safe. * Wording and code style tweaks suggested by Stolee in his review == Overview == This patch changes the default mode for sparse-checkout from non-cone mode to cone-mode, and marks non-cone mode as deprecated. There is no plan to remove non-cone mode, we are merely recommending against its use. The code change is pretty small, and most of this series is about documentation updates -- to focus on directories rather than patterns, to explain the new default, to explain why we are deprecating non-cone mode (the final patch), and to make other related cleanups to simplify the manual. Patch 1: Update tests to not assume cone-mode is the default Patch 2: Make cone-mode the default Patches 3-9: Various updates to git-sparse-checkout.txt, divided up for ease of review == Alternative == There is one primary alternative to this series: make sparse-checkout error when neither --cone nor --no-cone are specified (so that there is no default), and wait until a future date to make --cone the default. That'd be reasonable, but I had three reason to avoid going this route (note that item 2 means there's little practical difference between cone-mode-as-default and no-mode-is-default): 1. git-sparse-checkout.txt has the following huge warning early in the manual: """ THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR, AND THE BEHAVIOR OF OTHER COMMANDS IN THE PRESENCE OF SPARSE-CHECKOUTS, WILL LIKELY CHANGE IN THE FUTURE. """ 2. If users are unaware of the default change and attempt to provide patterns instead of directories, then they will get error messages added from en/sparse-checkout-fixes. They can learn at that time to get around the error messages by providing --no-cone. 3. If users are unaware of the default change and provide directories, then that's where non-cone mode and cone mode overlap and things happen to work. (There is a slight difference in that cone mode will include files from parent directories of any specified directory, but that means the user gets a few more files in their sparse-checkout with cone mode than they would with non-cone mode.) == CCs == Elijah Newren (9): tests: stop assuming --no-cone is the default mode for sparse-checkout sparse-checkout: make --cone the default git-sparse-checkout.txt: wording updates for the cone mode default git-sparse-checkout.txt: update docs for deprecation of 'init' git-sparse-checkout.txt: shuffle some sections and mark as internal git-sparse-checkout.txt: add a new EXAMPLES section git-sparse-checkout.txt: flesh out non-cone mode pattern discussion a bit git-sparse-checkout.txt: mark non-cone mode as deprecated Documentation: some sparsity wording clarifications Documentation/git-read-tree.txt | 9 +- Documentation/git-sparse-checkout.txt | 249 +++++++++++++++++++------- builtin/sparse-checkout.c | 2 +- t/t1091-sparse-checkout-builtin.sh | 15 +- t/t3602-rm-sparse-checkout.sh | 6 +- t/t3705-add-sparse-checkout.sh | 4 +- t/t6428-merge-conflicts-sparse.sh | 4 +- t/t7002-mv-sparse-checkout.sh | 2 +- t/t7012-skip-worktree-writing.sh | 2 +- 9 files changed, 207 insertions(+), 86 deletions(-) base-commit: 1a4874565fa3b6668042216189551b98b4dc0b1b Submitted-As: https://lore.kernel.org/git/pull.1148.v2.git.1647054681.gitgitgadget@gmail.com In-Reply-To: https://lore.kernel.org/git/pull.1148.git.1646725188.gitgitgadget@gmail.com
Assets 2
-
2022-03-12T03:11:21Z -
2022-03-12T03:11:21Z -