From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-4.0 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, SPF_HELO_NONE,SPF_NONE shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id AE4241F4B5 for ; Sun, 17 Nov 2019 21:05:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726525AbfKQVFS (ORCPT ); Sun, 17 Nov 2019 16:05:18 -0500 Received: from mail-wr1-f52.google.com ([209.85.221.52]:39709 "EHLO mail-wr1-f52.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726481AbfKQVFR (ORCPT ); Sun, 17 Nov 2019 16:05:17 -0500 Received: by mail-wr1-f52.google.com with SMTP id l7so17093175wrp.6 for ; Sun, 17 Nov 2019 13:05:17 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=mPeoWAcBb00eGe8EIY/HsjteDgVd3vEwluZm6lyqWhE=; b=Yil7hfqssX8dnsmT/3g0AsBOt0IYx0Cw98S3R1K57iCUo7ElJvzDqIPoA3qDEW3RmD h7gZdKWem3f8+HTvu3Lv0GnQJaQ5ySk7NSFtcEluWnXtW9fIZxyHoKsaI2QRSLMTWsAL i43lLZ3njWCm982VtwNk1tJJ5cGDcejVb6P/1SX23bAa5IshwyASq3g9lvDlmgBdqloB XieCj4Fsif8bAYiJ9Oi45S3nHwxUoJOLEyy1xn01jlw5JjfKXW9o+22RidRwQm7hXPv5 6wMz0wRNYPmeWWfscEa84+ymTtwik7I5FncaMxRNXlDvIc1mceUkDC1W5nnE+mLStPWv QG3A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=mPeoWAcBb00eGe8EIY/HsjteDgVd3vEwluZm6lyqWhE=; b=jLZA7aKnvNcC/KCTiijz9+naH5/VtxjtbxFdH46jaU7poV26Af4uLzROlor0NIk6Pu FV9LVfJBy1NgDpgun6LO96qXZChFXdCSZS0KyBLiB4v0RMyGXP307JFCGnbW8+yoT8zi YIJoGkKHpye2+HbYAYJ1ypk3zb0YHt+r/wXXmJFDHZk+3cfzmoGaAjVasHCCzT0140JY vn0HNSNDQJDDBQQJpmg0qBQoLnDjcGeH6/wdjn4uGC689x9Go/W3qGz1rMmBUIm4op7/ y9z5vSdfXPWUwin7YvMx/hijAQssOl+qdZi2VYV2ChN+qJVh55YdkVUIA1d5p+FitRhk SQ/A== X-Gm-Message-State: APjAAAVT3iMe9evYkublHLopsZjPOsSce9EGlZKMp/jiu4KamUyXyHz5 JHOAF0gZCGiqctEC+7x/FsN/lG1A X-Google-Smtp-Source: APXvYqx3wrK+XCCVGjlOclggskAV2DX83Zbk4+ZhRtZ0vk9dcwWgWf8ykyd3jStKoQDv5KvvSK5cgA== X-Received: by 2002:a5d:4649:: with SMTP id j9mr976845wrs.248.1574024716349; Sun, 17 Nov 2019 13:05:16 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id w4sm16820647wmk.29.2019.11.17.13.05.15 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 17 Nov 2019 13:05:15 -0800 (PST) Message-Id: <039598b04c94c9287be1d2d9fc2451439f59fd6e.1574024701.git.gitgitgadget@gmail.com> In-Reply-To: References: From: "Heba Waly via GitGitGadget" Date: Sun, 17 Nov 2019 21:04:58 +0000 Subject: [PATCH v5 19/21] submodule-config: move doc to submodule-config.h Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MIME-Version: 1.0 To: git@vger.kernel.org Cc: Heba Waly , Junio C Hamano , Heba Waly Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Heba Waly Move the documentation from Documentation/technical/api-submodule-config.txt to submodule-config.h as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file. Documentation/technical/api-submodule-config.txt is removed because the information it has is now redundant and it'll be hard to keep it up to date and synchronized with the documentation in the header file. The documentation of parse_submodule_config_option() is discarded as the function was removed 2 years ago. Signed-off-by: Heba Waly --- .../technical/api-submodule-config.txt | 66 ------------------- submodule-config.h | 38 ++++++++++- 2 files changed, 37 insertions(+), 67 deletions(-) delete mode 100644 Documentation/technical/api-submodule-config.txt diff --git a/Documentation/technical/api-submodule-config.txt b/Documentation/technical/api-submodule-config.txt deleted file mode 100644 index fb06089393..0000000000 --- a/Documentation/technical/api-submodule-config.txt +++ /dev/null @@ -1,66 +0,0 @@ -submodule config cache API -========================== - -The submodule config cache API allows to read submodule -configurations/information from specified revisions. Internally -information is lazily read into a cache that is used to avoid -unnecessary parsing of the same .gitmodules files. Lookups can be done by -submodule path or name. - -Usage ------ - -To initialize the cache with configurations from the worktree the caller -typically first calls `gitmodules_config()` to read values from the -worktree .gitmodules and then to overlay the local git config values -`parse_submodule_config_option()` from the config parsing -infrastructure. - -The caller can look up information about submodules by using the -`submodule_from_path()` or `submodule_from_name()` functions. They return -a `struct submodule` which contains the values. The API automatically -initializes and allocates the needed infrastructure on-demand. If the -caller does only want to lookup values from revisions the initialization -can be skipped. - -If the internal cache might grow too big or when the caller is done with -the API, all internally cached values can be freed with submodule_free(). - -Data Structures ---------------- - -`struct submodule`:: - - This structure is used to return the information about one - submodule for a certain revision. It is returned by the lookup - functions. - -Functions ---------- - -`void submodule_free(struct repository *r)`:: - - Use these to free the internally cached values. - -`int parse_submodule_config_option(const char *var, const char *value)`:: - - Can be passed to the config parsing infrastructure to parse - local (worktree) submodule configurations. - -`const struct submodule *submodule_from_path(const unsigned char *treeish_name, const char *path)`:: - - Given a tree-ish in the superproject and a path, return the - submodule that is bound at the path in the named tree. - -`const struct submodule *submodule_from_name(const unsigned char *treeish_name, const char *name)`:: - - The same as above but lookup by name. - -Whenever a submodule configuration is parsed in `parse_submodule_config_option` -via e.g. `gitmodules_config()`, it will overwrite the null_sha1 entry. -So in the normal case, when HEAD:.gitmodules is parsed first and then overlayed -with the repository configuration, the null_sha1 entry contains the local -configuration of a submodule (e.g. consolidated values from local git -configuration and the .gitmodules file in the worktree). - -For an example usage see test-submodule-config.c. diff --git a/submodule-config.h b/submodule-config.h index 1b4e2da658..42918b55e8 100644 --- a/submodule-config.h +++ b/submodule-config.h @@ -7,9 +7,31 @@ #include "submodule.h" #include "strbuf.h" +/** + * The submodule config cache API allows to read submodule + * configurations/information from specified revisions. Internally + * information is lazily read into a cache that is used to avoid + * unnecessary parsing of the same .gitmodules files. Lookups can be done by + * submodule path or name. + * + * Usage + * ----- + * + * The caller can look up information about submodules by using the + * `submodule_from_path()` or `submodule_from_name()` functions. They return + * a `struct submodule` which contains the values. The API automatically + * initializes and allocates the needed infrastructure on-demand. If the + * caller does only want to lookup values from revisions the initialization + * can be skipped. + * + * If the internal cache might grow too big or when the caller is done with + * the API, all internally cached values can be freed with submodule_free(). + * + */ + /* * Submodule entry containing the information about a certain submodule - * in a certain revision. + * in a certain revision. It is returned by the lookup functions. */ struct submodule { const char *path; @@ -41,13 +63,27 @@ int parse_update_recurse_submodules_arg(const char *opt, const char *arg); int parse_push_recurse_submodules_arg(const char *opt, const char *arg); void repo_read_gitmodules(struct repository *repo); void gitmodules_config_oid(const struct object_id *commit_oid); + +/** + * Same as submodule_from_path but lookup by name. + */ const struct submodule *submodule_from_name(struct repository *r, const struct object_id *commit_or_tree, const char *name); + +/** + * Given a tree-ish in the superproject and a path, return the submodule that + * is bound at the path in the named tree. + */ const struct submodule *submodule_from_path(struct repository *r, const struct object_id *commit_or_tree, const char *path); + +/** + * Use these to free the internally cached values. + */ void submodule_free(struct repository *r); + int print_config_from_gitmodules(struct repository *repo, const char *key); int config_set_in_gitmodules_file_gently(const char *key, const char *value); -- gitgitgadget