[
https://issues.apache.org/jira/browse/MNG-7862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17757397#comment-17757397
]
ASF GitHub Bot commented on MNG-7862:
-------------------------------------
elharo commented on code in PR #1217:
URL: https://github.com/apache/maven/pull/1217#discussion_r1301532825
##########
maven-model-builder/src/main/java/org/apache/maven/model/building/ModelSource3.java:
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.model.building;
+
+import org.apache.maven.model.locator.ModelLocator;
+
+/**
+ * Enhancement to the {@link ModelSource2} to support locating POM files using
the {@link ModelLocator}
+ * when pointing to a directory.
+ */
+public interface ModelSource3 extends ModelSource2 {
+ /**
+ * Returns model source identified by a path relative to this model source
POM. Implementation <strong>MUST</strong>
+ * be able to accept <code>relPath</code> parameter values that
Review Comment:
delete "be able to"
##########
maven-model-builder/src/main/java/org/apache/maven/model/building/ModelSource3.java:
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.model.building;
+
+import org.apache.maven.model.locator.ModelLocator;
+
+/**
+ * Enhancement to the {@link ModelSource2} to support locating POM files using
the {@link ModelLocator}
+ * when pointing to a directory.
+ */
+public interface ModelSource3 extends ModelSource2 {
+ /**
+ * Returns model source identified by a path relative to this model source
POM. Implementation <strong>MUST</strong>
+ * be able to accept <code>relPath</code> parameter values that
+ * <ul>
+ * <li>use either / or \ file path separator</li>
+ * <li>have .. parent directory references</li>
+ * <li>point either at file or directory, in the latter case the provided
{@code ModelLocator} will be used
Review Comment:
run-on sentence. Break up
##########
maven-model-builder/src/main/java/org/apache/maven/model/building/ModelSource3.java:
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.model.building;
+
+import org.apache.maven.model.locator.ModelLocator;
+
+/**
+ * Enhancement to the {@link ModelSource2} to support locating POM files using
the {@link ModelLocator}
+ * when pointing to a directory.
+ */
+public interface ModelSource3 extends ModelSource2 {
+ /**
+ * Returns model source identified by a path relative to this model source
POM. Implementation <strong>MUST</strong>
+ * be able to accept <code>relPath</code> parameter values that
+ * <ul>
+ * <li>use either / or \ file path separator</li>
+ * <li>have .. parent directory references</li>
+ * <li>point either at file or directory, in the latter case the provided
{@code ModelLocator} will be used
+ * to find the POM file, else if no locator is provided, a file named
'pom.xml' needs to be used by the
+ * requested model source.</li>
+ * </ul>
+ *
+ * @param relPath is the path of the requested model source relative to
this model source POM.
Review Comment:
delete "is the"
> The ModelLocator should always be used when locating pom.xml
> ------------------------------------------------------------
>
> Key: MNG-7862
> URL: https://issues.apache.org/jira/browse/MNG-7862
> Project: Maven
> Issue Type: Improvement
> Affects Versions: 4.0.0-alpha-7
> Reporter: Guillaume Nodet
> Assignee: Guillaume Nodet
> Priority: Major
> Fix For: 4.0.0-alpha-8
>
>
> There are a few places where the pom.xml location is hardcoded. There's a
> known interface to locate those, so those references should be cleaned.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)