You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "anukalp2804 (via GitHub)" <gi...@apache.org> on 2025/12/26 15:35:36 UTC
[PR] Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders [maven-scm]
anukalp2804 opened a new pull request, #1352:
URL: https://github.com/apache/maven-scm/pull/1352
### Summary
Improves documentation clarity by replacing TODO placeholders in
GitScmProviderRepository JavaDoc with meaningful descriptions.
### Changes
- Added descriptive JavaDoc for PROTOCOL_RSYNC
- Added clear @param and @return description for getUrl(RepositoryUrl)
### Rationale
Helps readability and maintainability.
No functional or behavioral changes.
Following this checklist to help us incorporate your
contribution quickly and easily:
- [x] Your pull request should address just one issue, without pulling in other changes.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Each commit in the pull request should have a meaningful subject line and body.
Note that commits might be squashed by a maintainer on merge.
- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
- [x] Run `mvn verify` to make sure basic checks pass.
A more thorough check will be performed on your pull request automatically.
- [ ] You have run the integration tests successfully (`mvn -Prun-its verify`).
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [x] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders [maven-scm]
Posted by "anukalp2804 (via GitHub)" <gi...@apache.org>.
anukalp2804 commented on PR #1352:
URL: https://github.com/apache/maven-scm/pull/1352#issuecomment-4665676724
Hello @slachiewicz ,
Just a gentle follow-up on this associated PR (#1352 ) . Whenever you have a chance, could you please review it and let me know if any changes or improvements are needed from my side?
Thank you for your time and consideration.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders [maven-scm]
Posted by "anukalp2804 (via GitHub)" <gi...@apache.org>.
anukalp2804 commented on PR #1352:
URL: https://github.com/apache/maven-scm/pull/1352#issuecomment-3708085600
Just checking in on this PR. It has been idle for a while and is still awaiting workflow approval and review.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders [maven-scm]
Posted by "anukalp2804 (via GitHub)" <gi...@apache.org>.
anukalp2804 commented on PR #1352:
URL: https://github.com/apache/maven-scm/pull/1352#issuecomment-3750487944
Hello @slachiewicz , this is a small documentation-only change improving JavaDoc clarity.
Could someone please review when time permits?
Thank you.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders [maven-scm]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #1352:
URL: https://github.com/apache/maven-scm/pull/1352#discussion_r2649094787
##########
maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java:
##########
@@ -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) {
+
Review Comment:
An unnecessary blank line has been added within the method body. This deviates from the surrounding code style where the method body starts immediately after the opening brace. The blank line should be removed to maintain consistency.
```suggestion
```
##########
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.
Review Comment:
The documentation states "Currently, rsync is recognized but not actively implemented by the Git SCM provider," which is misleading. Looking at the code, PROTOCOL_RSYNC is actually parsed from URLs (line 321-322), included in urlSupportsUserInformation (line 246), and used to construct repository URLs. While there may not be special rsync-specific handling, the protocol is functionally supported like other protocols. The documentation should clarify what "not actively implemented" means, or if rsync is actually fully supported, the documentation should reflect that accurately.
```suggestion
* This value is used when parsing SCM URLs and constructing repository
* URLs that use the rsync protocol. The Git SCM provider does not apply
* any rsync-specific behavior; rsync-based URLs are handled in the same
* generic way as other supported protocols.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders [maven-scm]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #1352:
URL: https://github.com/apache/maven-scm/pull/1352#issuecomment-4676235178
@slachiewicz Please assign appropriate label to PR according to the type of change.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders [maven-scm]
Posted by "slachiewicz (via GitHub)" <gi...@apache.org>.
slachiewicz merged PR #1352:
URL: https://github.com/apache/maven-scm/pull/1352
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org