[skip ci] Updated documentation

Fixes #41
xolstice · Oct 1, 2018 · 4881fa5 · 4881fa5
1 parent 0d4d6f7
commit 4881fa5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/src/site/apt/examples/protoc-artifact.apt.vm b/src/site/apt/examples/protoc-artifact.apt.vm
@@ -1,5 +1,5 @@
 ~~
-~~ Copyright (c) 2016 Maven Protocol Buffers Plugin Authors. All rights reserved.
+~~ Copyright (c) 2018 Maven Protocol Buffers Plugin Authors. All rights reserved.
 ~~
 ~~ Licensed under the Apache License, Version 2.0 (the "License");
 ~~ you may not use this file except in compliance with the License.
@@ -58,18 +58,17 @@ Resolving Protoc Artifact From Maven Central Repo
         <groupId>${project.groupId}</groupId>
         <artifactId>${project.artifactId}</artifactId>
         <version>${project.version}</version>
-        <extensions>true</extensions>
         <executions>
           <execution>
             <goals>
               <goal>compile</goal>
               <goal>test-compile</goal>
             </goals>
-            <configuration>
-              <protocArtifact>com.google.protobuf:protoc:3.4.0:exe:${os.detected.classifier}</protocArtifact>
-            </configuration>
           </execution>
         </executions>
+        <configuration>
+          <protocArtifact>com.google.protobuf:protoc:3.4.0:exe:${os.detected.classifier}</protocArtifact>
+        </configuration>
       </plugin>
       ...
     </plugins>
@@ -79,3 +78,6 @@ Resolving Protoc Artifact From Maven Central Repo
 </project>
 
 +-----+
+
+  Eclipse users, please also read
+  {{{https://github.com/trustin/os-maven-plugin/blob/master/README.md#issues-with-eclipse-m2e-or-other-ides}the following notes}}.
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <!--
-  ~ Copyright (c) 2016 Maven Protocol Buffers Plugin Authors. All rights reserved.
+  ~ Copyright (c) 2018 Maven Protocol Buffers Plugin Authors. All rights reserved.
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.
@@ -47,6 +47,10 @@
                 There is a limited support in the plugin for integration with M2E 1.5 and later.
                 Versions of M2E prior to 1.5 will fail to work with the plugin because of a
                 <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=422106">class loading bug</a>.
+
+                <p>Also, if using <code>os-maven-plugin</code> to help resolve binary artifacts,
+                please make sure that you have read
+                <a href="https://github.com/trustin/os-maven-plugin/blob/master/README.md#issues-with-eclipse-m2e-or-other-ides">these important notes</a>.</p>
             </answer>
         </faq>