(maven-scm) branch master updated: Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders (#1352)

[slachiewicz]

This is an automated email from the ASF dual-hosted git repository.

slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-scm.git


The following commit(s) were added to refs/heads/master by this push:
     new 55494d539 Improve JavaDoc in GitScmProviderRepository by replacing 
TODO placeholders (#1352)
55494d539 is described below

commit 55494d53916cb6746810581b26dd7f92f65a6ba2
Author: Anukalp Pandey <225702675+anukalp2...@users.noreply.github.com>
AuthorDate: Thu Jun 11 06:34:44 2026 +0530

    Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders 
(#1352)
    
    * Document deprecation rationale for executeChangeLogCommand overloads
    
    * Improve JavaDoc in GitScmProviderRepository
---
 .../git/repository/GitScmProviderRepository.java        | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git 
a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java
 
b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java
index e657c2b3e..2e0a7310f 100644
--- 
a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java
+++ 
b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java
@@ -75,8 +75,11 @@ public class GitScmProviderRepository extends 
ScmProviderRepositoryWithHost {
     public static final String PROTOCOL_HTTPS = "https";
 
     /**
-     * Use rsync for retrieving the data
-     * TODO implement!
+     * Protocol identifier for repositories accessed via <code>rsync</code>.
+     *
+     * This value is used when parsing SCM URLs and represents a repository
+     * that is retrieved using the rsync protocol. Currently, rsync is
+     * recognized but not actively implemented by the Git SCM provider.
      */
     public static final String PROTOCOL_RSYNC = "rsync";
 
@@ -226,10 +229,16 @@ private RepositoryUrl parseUrl(String url) throws 
ScmException {
     }
 
     /**
-     * @param repoUrl
-     * @return TODO
+     * Builds the effective Git repository URL from the parsed SCM URL
+     * definition.
+     *
+     * @param repoUrl parsed repository descriptor containing host,
+     *                protocol, and path information
+     * @return the normalized remote repository URL that Maven SCM will
+     *         use for Git operations
      */
     private String getUrl(RepositoryUrl repoUrl) {
+
         StringBuilder urlSb = new StringBuilder(repoUrl.getProtocol());
         boolean urlSupportsUserInformation = false;