Skip to content

Commit

Permalink
Merge pull request #5842 from bobjacobsen/docs
Browse files Browse the repository at this point in the history 
Add Jenkins summary page
  • Loading branch information
@bobjacobsen
bobjacobsen committed Sep 21, 2018
2 parents 5391927 + 7f6963a commit bcf4db5
Show file tree
Hide file tree
Showing 11 changed files with 142 additions and 73 deletions.
1 change: 0 additions & 1 deletion .gitignore
View file
Expand Up @@ -41,7 +41,6 @@ session.log
/xml/XSLT/pages
.run.sh
hs_err_pid*.log
tmp.ser

# private / per-user configuration files
/nbproject/private
Expand Down
3 changes: 2 additions & 1 deletion help/en/Acknowledgements.shtml
View file
Expand Up @@ -627,7 +627,8 @@
<li>Alain Le Marchand, who provided a number of decoder
definitions and updates</li><!-- GitHub: AlanUS -->

<li>Karl Johan Lisby, who made large improvements to the
<li>Karl Johan Lisby, <!-- kjlisby -->
who made large improvements to the
Uhlenbrock Intellibox support and contributed the Signal
Controlled Warrant support</li>

Expand Down
101 changes: 101 additions & 0 deletions help/en/html/doc/Technical/CI-status.shtml
View file
@@ -0,0 +1,101 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>

<title>
JMRI: CI Status
</title>

<!--#include virtual="/Style.shtml" -->
</head>

<body>
<!--#include virtual="/Header.shtml" -->

<!--#include virtual="/Sidebar.shtml" --> <!-- select the local or global Sidebar file -->
<div id="mainContent">

<h1>CI Status</h1>

<table>
<tr><td align="right">
Development:</td><td>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/Builds/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/SpotBugs'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/Deprecations/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/SpotBugs'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/HTML%20Scan/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/HTML%20Scan'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/JaCoCo/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/SpotBugs'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/Packages/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/SpotBugs'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/Separate_Tests/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/Separate_Tests'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/SpotBugs/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/SpotBugs'></a>
</td></tr><tr><td align="right">
Version Checks:</td><td>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/VersionChecks/job/JDK%2010.0.1/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/VersionChecks/JDK%2010.0.1'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/VersionChecks/job/JDK%209.0.4/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/VersionChecks/JDK%209.0.4'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/VersionChecks/job/JRE%2010.0.1/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/VersionChecks/JRE%2010.0.1'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/VersionChecks/JRE%208u181'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/VersionChecks/JRE%208u181'></a>
<a href='http://jmri.tagadab.com/jenkins/job/Development/job/VersionChecks/job/JRE%209.0.4/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=Development/VersionChecks/JRE%209.0.4'></a>
</td></tr><tr><td align="right">
Web Site:</td><td>
<a href='http://jmri.tagadab.com/jenkins/job/WebSite/job/generate-website/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=WebSite/generate-website'></a>
<a href='http://jmri.tagadab.com/jenkins/job/WebSite/job/JMRI_repository/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=WebSite/JMRI_repository'></a>
<a href='http://jmri.tagadab.com/jenkins/job/WebSite/job/website_repository/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=WebSite/website_repository'></a>
<a href='http://jmri.tagadab.com/jenkins/job/WebSite/job/website-legal_repository/'><img src='http://jmri.tagadab.com/jenkins/buildStatus/icon?job=WebSite/website-legal_repository'></a>
</td></tr>
</table>

<table>

<tr><td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/SpotBugs/">SpotBugs</a><br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/SpotBugs/1956/findbugsResult/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/SpotBugs/findbugs/trendGraph/png?url=PRIORITY">
</a>
</td>

<td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/Deprecations/">Deprecations</a><br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/Deprecations/lastBuild/warnings4Result/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/Deprecations/warnings4/trendGraph/png?url=PRIORITY">
</a>
</td></tr>

<tr><td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/SpotBugs/">SpotBugs</a> (Incremental)<br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/SpotBugs/1956/findbugsResult/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/SpotBugs/findbugs/trendGraph/png?url=FIXED">
</a>
</td>

<td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/Deprecations/">Deprecations</a> (Incremental)<br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/Deprecations/lastBuild/warnings4Result/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/Deprecations/warnings4/trendGraph/png?url=FIXED">
</a>
</td></tr>

<tr><td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/">Builds</a> - Unit Test Results<br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/lastBuild/testReport/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/test/trend">
</a>
</td>

<td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/">Builds</a> - Regular Java warnings<br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/lastBuild/warnings10Result/NORMAL/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/warnings10/trendGraph/png?url=PRIORITY">
</a>
</td></tr>

<tr><td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/">Builds</a> - ECJ Java warnings<br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/lastBuild/warnings25Result/NORMAL/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/warnings25/trendGraph/png?url=PRIORITY">
</a>
</td>

<td><a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/">Builds</a> - Javadoc results<br>
<a href="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/lastBuild/warnings42Result/NORMAL/">
<img src="http://jmri.tagadab.com/jenkins/job/Development/job/Builds/warnings42/trendGraph/png?url=PRIORITY">
</a>
</td></tr>
</table>

<!--#include virtual="/Footer.shtml" -->

</div><!-- closes #mainContent-->
</body>
</html>
4 changes: 3 additions & 1 deletion help/en/html/doc/Technical/ContinuousIntegration.shtml
View file
Expand Up @@ -40,7 +40,9 @@
"#jenkins">Jenkins</a> jobs that routinely build the code,
run checks, and creates downloadable installers. That means
that we can and do put changes into our users hands very
quickly.</p>
quickly. There's a
<a href="CI-status.shtml">CI status page</a>
that shows the combined status of that.</p>

<p>We also use two additioanl CI engines to test every change
entered into our GitHub code repository.</p>
Expand Down
22 changes: 8 additions & 14 deletions java/src/jmri/configurexml/AbstractXmlAdapter.java
View file
Expand Up @@ -12,15 +12,7 @@ public abstract class AbstractXmlAdapter implements XmlAdapter {

private ErrorHandler errorHandler = XmlAdapter.getDefaultExceptionHandler();

@Override
public void creationErrorEncountered(
String description,
String systemName,
String userName,
Exception exception) throws JmriConfigureXmlException {
this.handleException(description, null, systemName, userName, exception);
}

/** {@inheritDoc} */
@Override
public void handleException(
String description,
Expand All @@ -33,16 +25,19 @@ public void handleException(
}
}

/** {@inheritDoc} */
@Override
public boolean load(Element e) throws JmriConfigureXmlException {
throw new UnsupportedOperationException("One of the other load methods must be implemented.");
}

/** {@inheritDoc} */
@Override
public boolean load(Element shared, Element perNode) throws JmriConfigureXmlException { // may not need exception
return this.load(shared);
}

/** {@inheritDoc} */
@Override
public void load(Element shared, Element perNode, Object o) throws JmriConfigureXmlException { // may not need exception
this.load(shared, o);
Expand All @@ -65,16 +60,13 @@ public boolean loadDeferred() {
return false;
}

/**
* Get the order to load items from XML files in.
*
* @return the order
*/
/** {@inheritDoc} */
@Override
public int loadOrder() {
return 50;
}

/** {@inheritDoc} */
@Override
public Element store(Object o, boolean shared) {
if (shared) {
Expand All @@ -83,11 +75,13 @@ public Element store(Object o, boolean shared) {
return null;
}

/** {@inheritDoc} */
@Override
public void setExceptionHandler(ErrorHandler errorHandler) {
this.errorHandler = errorHandler;
}

/** {@inheritDoc} */
@Override
public ErrorHandler getExceptionHandler() {
return this.errorHandler;
Expand Down
52 changes: 21 additions & 31 deletions java/src/jmri/configurexml/ConfigXmlManager.java
View file
Expand Up @@ -40,11 +40,13 @@ public class ConfigXmlManager extends jmri.jmrit.XmlFile
public ConfigXmlManager() {
}

/** {@inheritDoc} */
@Override
public void registerConfig(Object o) {
registerConfig(o, 50);
}

/** {@inheritDoc} */
@Override
public void registerPref(Object o) {
// skip if already present, leaving in original order
Expand Down Expand Up @@ -92,16 +94,14 @@ static public String currentClassName(String name) {
return InstanceManager.getDefault(ClassMigrationManager.class).getClassName(name);
}

/**
* Remove the registered preference items. This is used, for example, when a
* GUI wants to replace the preferences with new values.
*/
/** {@inheritDoc} */
@Override
public void removePrefItems() {
log.debug("removePrefItems dropped {}", plist.size());
plist.clear();
}

/** {@inheritDoc} */
@Override
public Object findInstance(Class<?> c, int index) {
List<Object> temp = new ArrayList<>(plist);
Expand All @@ -119,6 +119,7 @@ public Object findInstance(Class<?> c, int index) {
return null;
}

/** {@inheritDoc} */
@Override
public List<Object> getInstanceList(Class<?> c) {
List<Object> result = new ArrayList<>();
Expand All @@ -136,6 +137,7 @@ public List<Object> getInstanceList(Class<?> c) {
return result;
}

/** {@inheritDoc} */
@Override
public void registerConfig(Object o, int x) {
// skip if already present, leaving in original order
Expand All @@ -151,6 +153,7 @@ public void registerConfig(Object o, int x) {
clist.put(o, x);
}

/** {@inheritDoc} */
@Override
public void registerTool(Object o) {
// skip if already present, leaving in original order
Expand Down Expand Up @@ -187,6 +190,7 @@ public void registerUser(Object o) {
ulist.add(o);
}

/** {@inheritDoc} */
@Override
public void registerUserPrefs(Object o) {
// skip if already present, leaving in original order
Expand All @@ -202,6 +206,7 @@ public void registerUserPrefs(Object o) {
uplist.add(o);
}

/** {@inheritDoc} */
@Override
public void deregister(Object o) {
plist.remove(o);
Expand Down Expand Up @@ -378,11 +383,7 @@ protected boolean finalStore(Element root, File file) {
return true;
}

/**
* Writes config, tools and user to a file.
*
* @param file config file to write
*/
/** {@inheritDoc} */
@Override
public boolean storeAll(File file) {
boolean result = true;
Expand All @@ -406,14 +407,13 @@ public boolean storeAll(File file) {
return result;
}

/**
* Writes prefs to a predefined File location.
*/
/** {@inheritDoc} */
@Override
public void storePrefs() {
storePrefs(prefsFile);
}

/** {@inheritDoc} */
@Override
public void storePrefs(File file) {
synchronized (this) {
Expand All @@ -423,6 +423,7 @@ public void storePrefs(File file) {
}
}

/** {@inheritDoc} */
@Override
public void storeUserPrefs(File file) {
synchronized (this) {
Expand All @@ -445,11 +446,7 @@ public void setPrefsLocation(File prefsFile) {
}
File prefsFile;

/**
* Writes prefs to a file.
*
* @param file config file to write.
*/
/** {@inheritDoc} */
@Override
public boolean storeConfig(File file) {
boolean result = true;
Expand All @@ -464,14 +461,7 @@ public boolean storeConfig(File file) {
return result;
}

/**
* Writes user and config info to a file.
* <P>
* Config is included here because it doesn't hurt to read it again, and the
* user data (typically a panel) requires it to be present first.
*
* @param file config file to write
*/
/** {@inheritDoc} */
@Override
public boolean storeUser(File file) {
boolean result = true;
Expand All @@ -489,6 +479,7 @@ public boolean storeUser(File file) {
return result;
}

/** {@inheritDoc} */
@Override
public boolean makeBackup(File file) {
return makeBackupFile(defaultBackupDirectory, file);
Expand Down Expand Up @@ -556,6 +547,7 @@ public boolean load(File fi) throws JmriConfigureXmlException {
return load(fi, false);
}

/** {@inheritDoc} */
@Override
public boolean load(URL url) throws JmriConfigureXmlException {
return load(url, false);
Expand Down Expand Up @@ -615,17 +607,13 @@ public boolean load(URL url, boolean registerDeferred) throws JmriConfigureXmlEx

private XmlFile.Validate validate = XmlFile.Validate.CheckDtdThenSchema;

/**
* Default XML verification. Public to allow scripting.
*/
/** {@inheritDoc} */
@Override
public void setValidate(XmlFile.Validate v) {
validate = v;
}

/**
* Default XML verification. Public to allow scripting.
*/
/** {@inheritDoc} */
@Override
public XmlFile.Validate getValidate() {
return validate;
Expand Down Expand Up @@ -761,11 +749,13 @@ private Boolean loadOnSwingThread(URL url, boolean registerDeferred) throws Jmri
return result;
}

/** {@inheritDoc} */
@Override
public boolean loadDeferred(File fi) {
return this.loadDeferred(FileUtil.fileToURL(fi));
}

/** {@inheritDoc} */
@Override
public boolean loadDeferred(URL url) {
boolean result = true;
Expand Down

0 comments on commit bcf4db5

Please sign in to comment.