Frequently Asked Questions

General

1. How do I use jmd?
2. How do I use jmd via maven2?
3. How do I build the site?
4. How do I configure checks?
5. How do I implement a custom check?

General

How do I use jmd?

java -jar modi.jar -Dam=/path/to/am -Ddm=/path/to/dm

---

How do I use jmd via maven2?

We have implemented a maven-jmd-plugin which generates a JMD Report. You can use it in your pom.xml by defining it in the reporting section:

...
<reporting>
    <plugins>
        <plugin>
            <groupId>net.sf.jmd</groupId>
            <artifactId>maven-jmd-plugin</artifactId>
            <version>0.1.0-SNAPSHOT</version>
            <configuration>
                <jmdConfigFile>
                    src/arch/jmdConfig.properties
                </jmdConfigFile>
                <amRoot>src/arch/java</amRoot>
                <dmRoot>src/main/java</dmRoot>
            </configuration>
        </plugin>
...
					

As the maven-jmd-plugin is currently not in the maven central repository, you can either use the repository provided here at sf.net (see below) or check it out from svn and build it yourself (see below).

1. Getting maven-jmd-plugin from the m2repository:
   
   edit your ~/.m2/settingx.xml and add a profile containing the jmd repository:

   ...
   <activeProfiles>
       <activeProfile>withJmdRepo</activeProfile>
   </activeProfiles>
   
   <profiles>
     <profile>
       <id>withJmdRepo</id>
       <repositories>
         <repository>
           <id>central</id>
           <name>Maven Repository Switchboard</name>
           <layout>default</layout>
           <url>http://repo1.maven.org/maven2</url>
           <snapshots>
             <enabled>false</enabled>
           </snapshots>
         </repository>
       </repositories>
     
       <pluginRepositories>
         <pluginRepository>
           <id>central</id>
           <name>Maven Plugin Repository</name>
           <url>http://repo1.maven.org/maven2</url>
           <layout>default</layout>
           <snapshots>
             <enabled>false</enabled>
           </snapshots>
         </pluginRepository>
         <pluginRepository>
           <id>jmd.sf.net</id>
           <url>http://jmd.sf.net/m2repository</url>
           <snapshots>
             <enabled>true</enabled>
           </snapshots>
         </pluginRepository>
       </pluginRepositories>
     </profile>
   </profiles>
   ...
   					           

2. Getting maven-jmd-plugin from the sources ist described here.

---

How do I build the site?

Use Maven and the following goals:

mvn clean test-compile site

---

How do I configure checks?

... when its done.

---

How do I implement a custom check?

... when its done.