You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2021/11/11 16:27:26 UTC
[maven] branch MNG-7129-master updated: [MNG-7321] move
documentation to maven-caching module
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MNG-7129-master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/MNG-7129-master by this push:
new fe34637 [MNG-7321] move documentation to maven-caching module
fe34637 is described below
commit fe3463789821b299afa7308f59269135d5a05570
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Thu Nov 11 17:27:23 2021 +0100
[MNG-7321] move documentation to maven-caching module
---
README.md | 2 +-
maven-caching/src/site/apt/index.apt | 30 ++++++++++++
.../src/site/markdown}/CACHE-HOWTO.md | 0
.../src/site/markdown}/CACHE-PARAMETERS.md | 0
.../src/site/markdown}/CACHE-REMOTE.md | 0
.../src/site/markdown}/CACHE.md | 0
.../src/site/markdown}/maven-cache-config.xml | 0
maven-caching/src/site/site.xml | 53 ++++++++++++++++++++++
8 files changed, 84 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index a5a193b..03fe9c2 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ If you think you have found a bug, please file an issue in the [Maven Issue Trac
Incremental Build and Cache
-------------
This maven version supports Incremental Build feature which calculates out-of-date modules in the build dependencies graph and improves build times by avoiding re-building unnecessary modules.
-Read [cache guide](Documentation/CACHE.md) for more details
+Read [cache guide](maven-caching/src/site/markdown/CACHE.md) for more details.
Documentation
-------------
diff --git a/maven-caching/src/site/apt/index.apt b/maven-caching/src/site/apt/index.apt
new file mode 100644
index 0000000..db29a8d
--- /dev/null
+++ b/maven-caching/src/site/apt/index.apt
@@ -0,0 +1,30 @@
+~~ 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.
+
+ -----
+ Introduction
+ -----
+ Hervé Boutemy
+ -----
+ 2021-11-11
+ -----
+
+Maven Caching
+
+ Maven Incremental Build and Cache (local and remote).
+
+ Read {{{./CACHE.html} more documentation}}.
diff --git a/Documentation/CACHE-HOWTO.md b/maven-caching/src/site/markdown/CACHE-HOWTO.md
similarity index 100%
rename from Documentation/CACHE-HOWTO.md
rename to maven-caching/src/site/markdown/CACHE-HOWTO.md
diff --git a/Documentation/CACHE-PARAMETERS.md b/maven-caching/src/site/markdown/CACHE-PARAMETERS.md
similarity index 100%
rename from Documentation/CACHE-PARAMETERS.md
rename to maven-caching/src/site/markdown/CACHE-PARAMETERS.md
diff --git a/Documentation/CACHE-REMOTE.md b/maven-caching/src/site/markdown/CACHE-REMOTE.md
similarity index 100%
rename from Documentation/CACHE-REMOTE.md
rename to maven-caching/src/site/markdown/CACHE-REMOTE.md
diff --git a/Documentation/CACHE.md b/maven-caching/src/site/markdown/CACHE.md
similarity index 100%
rename from Documentation/CACHE.md
rename to maven-caching/src/site/markdown/CACHE.md
diff --git a/Documentation/maven-cache-config.xml b/maven-caching/src/site/markdown/maven-cache-config.xml
similarity index 100%
rename from Documentation/maven-cache-config.xml
rename to maven-caching/src/site/markdown/maven-cache-config.xml
diff --git a/maven-caching/src/site/site.xml b/maven-caching/src/site/site.xml
new file mode 100644
index 0000000..aa24fb5
--- /dev/null
+++ b/maven-caching/src/site/site.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ <item name="maven-cache-config.xml" href="cache-config.html"/>
+ </menu>
+
+ <menu name="Documentation">
+ <item name="Overview" href="CACHE.html"/>
+ <item name="Howto" href="CACHE-HOWTO.html"/>
+ <item name="Parameters" href="CACHE-PARAMETERS.html"/>
+ <item name="Remote" href="CACHE-REMOTE.html"/>
+ </menu>
+
+ <menu name="Cache Internals">
+ <item name="buildinfo.xml" href="cache-build.html"/>
+ <item name="diff-*.xml" href="cache-diff.html"/>
+ <item name="cache-report.xml" href="cache-report.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file