From 94121295e57a1d6e713b8e3ba84261d9e9cfebe6 Mon Sep 17 00:00:00 2001 From: Jim Edwards Date: Tue, 14 May 2024 13:48:01 -0600 Subject: [PATCH] update documentation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f8afb40..d1ef632 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Git-fleximod is a Python-based tool that extends Git's submodule and sparse chec status: Display the status of submodules. update: Update submodules to the tag indicated in .gitmodules variable fxtag. test: Make sure that fxtags and submodule hashes are consistant, - make sure that official urls (as defined by fxurl) are set + make sure that official urls (as defined by fxDONOTUSEurl) are set make sure that fxtags are defined for all submodules Additional Options: See git fleximod --help for more details. @@ -34,8 +34,8 @@ Git-fleximod is a Python-based tool that extends Git's submodule and sparse chec - AlwaysRequired: Always required (always checked out). - AlwaysOptional: Always optional (checked out with --optional flag). fxsparse: Enable sparse checkout for a submodule, pointing to a file containing sparse checkout paths. - fxurl: This is the url used in the test subcommand to assure that protected branches do not point to forks - **NOTE** the fxurl variable is only used to identify the official project repository and should not be + fxDONOTUSEurl: This is the url used in the test subcommand to assure that protected branches do not point to forks + **NOTE** the fxDONOTUSEurl variable is only used to identify the official project repository and should not be changed by users. Use the url variable to change to a fork if desired. ## Sparse Checkouts