Skip to content

Commit

Permalink
Updates for Apache incubation
Browse files Browse the repository at this point in the history
- Update URLs to point to apache infrastructure
- Add Apache incubating DISCLAIMER
- Remove the use of git to determine version numbers. The version is
  now hardcoded in build.sbt and needs to be updated manually. Not only
  does this reduce complexity, it allows one to build Daffodil from
  source tarballs without needing git installed and without needing
  certain branches and tags.
- Remove the NCSA resolver, not needed for any dependency resolution

DAFFODIL-1856
  • Loading branch information
stevedlawrence committed Nov 27, 2017
1 parent 8951771 commit 41a0dc7
Show file tree
Hide file tree
Showing 16 changed files with 81 additions and 213 deletions.
7 changes: 7 additions & 0 deletions DISCLAIMER
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Apache Daffodil is an effort undergoing incubation at The Apache Software
Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required
of all newly accepted projects until a further review indicates that the
infrastructure, communications, and decision making process have stabilized in
a manner consistent with other successful ASF projects. While incubation status
is not necessarily a reflection of the completeness or stability of the code,
it does indicate that the project has yet to be fully endorsed by the ASF.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Daffodil
# Apache Daffodil (incubating)

## Introduction

Daffodil is the open source implementation of the [Data Format Description Language (DFDL)](http://www.ogf.org/dfdl), a specification created by the [Open Grid Forum](http://www.ogf.org). DFDL is capable of describing many data formats, including textual and binary, commercial record-oriented, scientific and numeric, modern and legacy, and many industry standards. It leverages XML technology and concepts, using a subset of W3C XML schema type system and annotations to describe such data. Daffodil uses this description to parse data into an infoset represented as XML or JSON, easily capable of ingestion, validation, and transformation.
Apache Daffodil (incubating) is the open source implementation of the [Data Format Description Language (DFDL)](http://www.ogf.org/dfdl), a specification created by the [Open Grid Forum](http://www.ogf.org). DFDL is capable of describing many data formats, including textual and binary, commercial record-oriented, scientific and numeric, modern and legacy, and many industry standards. It leverages XML technology and concepts, using a subset of W3C XML schema type system and annotations to describe such data. Daffodil uses this description to parse data into an infoset represented as XML or JSON, easily capable of ingestion, validation, and transformation.

For more information about Daffodil, see the [Daffodil Wiki](https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Daffodil%3A+Open+Source+DFDL).
For more information about Daffodil, see https://daffodil.apache.org/.

## Build Requirements

Expand All @@ -28,17 +28,17 @@ $ sbt test
$ sbt cli
```

To build the Daffodil CLI:
To build the Daffodil command line interface:

```bash
$ sbt stage
```

The above will create Linux and Windows shell scripts in `daffodil-cli/target/universal/stage/bin/`. See the [Daffodil CLI](https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Command+Line+Interface) for details on its usage.
The above will create Linux and Windows shell scripts in `daffodil-cli/target/universal/stage/bin/`. See the [Command Line Interface](https://cwiki.apache.org/confluence/display/DAFFODIL/Command+Line+Interface) documentation for details on its usage.

## Getting Help

For questions, we can be reached on the [Daffodil users mailing list](http://oss.tresys.com/mailman/listinfo/daffodil-users) or in the #Daffodil room on [NCSA HipChat](http://hipchat.ncsa.illinois.edu/gvZdmJHmq). Bugs can be reported via the [Daffodil JIRA](https://opensource.ncsa.illinois.edu/jira/projects/DFDL/), or via email at [[email protected]](mailto:[email protected]) for company confidential, FOUO, or security relevant issues.
For questions, we can be reached at the [email protected] or [email protected] mailing lists or in #Daffodil on [ASF HipChat](https://www.hipchat.com/gJt9EQs5l). Bugs can be reported via the [Daffodil JIRA](https://issues.apache.org/jira/projects/DAFFODIL).

## License

Expand Down
20 changes: 5 additions & 15 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ name := "daffodil"

organization in ThisBuild := "edu.illinois.ncsa"

version in ThisBuild := "2.1.0-SNAPSHOT"

scalaVersion in ThisBuild := "2.11.8"

// incOptions := incOptions.value.withNameHashing(true) // 2.11 experimental incremental compilation improvements (perhaps not working right?)
Expand All @@ -21,8 +23,6 @@ testOptions in ThisBuild += Tests.Argument(TestFrameworks.JUnit, "-v")

transitiveClassifiers := Seq("sources", "javadoc")

resolvers in ThisBuild += "NCSA Sonatype Releases" at "https://opensource.ncsa.illinois.edu/nexus/content/repositories/releases"

libraryDependencies in ThisBuild := Seq(
"org.scala-lang.modules" %% "scala-xml" % "1.0.6",
"org.scala-lang.modules" %% "scala-parser-combinators" % "1.0.4",
Expand Down Expand Up @@ -65,23 +65,13 @@ publishArtifact in Test := false

pomIncludeRepository in ThisBuild := { _ => false }

pomExtra in ThisBuild := (
<developers>
<developer>
<id>Tresys Technology</id>
<name>Tresys Technology</name>
<url>http://www.tresys.com</url>
</developer>
</developers>
)

scmInfo := Some(
ScmInfo(
browseUrl = url("https://opensource.ncsa.illinois.edu/stash/projects/DFDL/repos/daffodil/browse"),
connection = "scm:git:https://opensource.ncsa.illinois.edu/stash/scm/dfdl/daffodil.git"
browseUrl = url("https://git-wip-us.apache.org/repos/asf?p=incubator-daffodil.git"),
connection = "scm:git:git://git.apache.org/incubator-daffodil.git"
)
)

licenses in ThisBuild := Seq("University of Illinois/NCSA Open Source License" -> url("http://opensource.org/licenses/UoI-NCSA.php"))

homepage in ThisBuild := Some(url("https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Home"))
homepage in ThisBuild := Some(url("https://daffodil.apache.org"))
12 changes: 6 additions & 6 deletions daffodil-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

# Daffodil
# Apache Daffodil (incubating)

## Introduction

Daffodil is the open source implementation of the [Data Format Description Language (DFDL)](http://www.ogf.org/dfdl), a specification created by the [Open Grid Forum](http://www.ogf.org). DFDL is capable of describing many data formats, including textual and binary, commercial record-oriented, scientific and numeric, modern and legacy, and many industry standards. It leverages XML technology and concepts, using a subset of W3C XML schema type system and annotations to describe such data. Daffodil uses this description to parse data into an infoset represented as XML or JSON, easily capable of ingestion, validation, and transformation.
Apache Daffodil (incubating) is the open source implementation of the [Data Format Description Language (DFDL)](http://www.ogf.org/dfdl), a specification created by the [Open Grid Forum](http://www.ogf.org). DFDL is capable of describing many data formats, including textual and binary, commercial record-oriented, scientific and numeric, modern and legacy, and many industry standards. It leverages XML technology and concepts, using a subset of W3C XML schema type system and annotations to describe such data. Daffodil uses this description to parse data into an infoset represented as XML or JSON, easily capable of ingestion, validation, and transformation.

For more information about Daffodil, see the [Daffodil Wiki](https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Daffodil%3A+Open+Source+DFDL).
For more information about Daffodil, see https://daffodil.apache.org/.

## Requirements

Expand All @@ -25,7 +25,7 @@ To execute Daffodil on Windows:
$ .\bin\daffodil.bat [options]
```

Use the `--help` option or see the [Daffodil CLI](https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Command+Line+Interface) documentation for details on its usage.
Use the `--help` option or see the [Command Line Interface](https://cwiki.apache.org/confluence/display/DAFFODIL/Command+Line+Interface) documentation for details on its usage.

### Debugging

Expand All @@ -37,11 +37,11 @@ $ ./bin/daffodil -d parse --schema <path/to/schema.dfdl.xsd> input-file

When running the debugger, the user is provided with a command prompt, at which point the user can execute debugger commands to control the debugger and inspect state. Type `help` at the command prompt to get information on the debugger commands, or `help <command>` to get information about a specific command.

See the [Interactive Debugger](https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Interactive+Debugger) page for its detailed usage.
See the [Interactive Debugger](https://cwiki.apache.org/confluence/display/DAFFODIL/Interactive+Debugger) page for its detailed usage.

## Getting Help

For questions, we can be reached on the [Daffodil users mailing list](http://oss.tresys.com/mailman/listinfo/daffodil-users) or in the #Daffodil room on [NCSA HipChat](http://hipchat.ncsa.illinois.edu/gvZdmJHmq). Bugs can be reported via the [Daffodil JIRA](https://opensource.ncsa.illinois.edu/jira/projects/DFDL/), or via email at [[email protected]](mailto:[email protected]) for company confidential, FOUO, or security relevant issues.
For questions, we can be reached at the [email protected] or [email protected] mailing lists or in #Daffodil on [ASF HipChat](https://www.hipchat.com/gJt9EQs5l). Bugs can be reported via the [Daffodil JIRA](https://issues.apache.org/jira/projects/DAFFODIL).

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ class CLIConf(arguments: Array[String]) extends scallop.ScallopConf(arguments)
uri.getOrElse(throw new Exception("Could not find file or resource %s" format s))
})

printedName = "daffodil"
printedName = "Apache Daffodil (incubating)"

helpWidth(76)

Expand All @@ -312,16 +312,16 @@ class CLIConf(arguments: Array[String]) extends scallop.ScallopConf(arguments)
sys.exit(1)
}

banner("""|Usage: %s [GLOBAL_OPTS] <subcommand> [SUBCOMMAND_OPTS]
banner("""|Usage: daffodil [GLOBAL_OPTS] <subcommand> [SUBCOMMAND_OPTS]
|
|Global Options:""".format(printedName).stripMargin)
|Global Options:""".stripMargin)

footer("""|
|Run '%s <subcommand> --help' for subcommand specific options""".format(printedName).stripMargin)
|Run 'daffodil <subcommand> --help' for subcommand specific options""".stripMargin)

version({
val versions = Misc.getDaffodilVersion
val strVers = "%s %s (build %s)".format(printedName, versions._1, versions._2)
val version = Misc.getDaffodilVersion
val strVers = "%s %s".format(printedName, version)
strVers
})

Expand Down Expand Up @@ -1281,7 +1281,7 @@ object Main extends Logging {
|
| Please report this bug and help us fix it:
|
| https://opensource.ncsa.illinois.edu/confluence/display/DFDL/How+to+Report+a+Bug
| https://cwiki.apache.org/confluence/display/DAFFODIL/Report+a+Bug
|
| Please include the following exception, the command you
| ran, and any input, schema, or tdml files used that led
Expand All @@ -1305,8 +1305,7 @@ object Main extends Logging {
| You can create a bug and track the progress of this
| feature at:
|
| https://opensource.ncsa.illinois.edu/jira/browse/DFDL
|
| https://issues.apache.org/jira/projects/DAFFODIL
|""".format(e.getMessage()).stripMargin)
1
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ class Compiler private[japi] () {
/**
* Read external variables from a Daffodil configuration file
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
*
* @param extVarsFile file to read DFDL variables from.
*/
Expand All @@ -250,7 +250,7 @@ class Compiler private[japi] () {
/**
* Set a Daffodil tunable parameter
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
*
* @param tunable name of the tunable parameter to set.
* @param value value of the tunable parameter to set
Expand All @@ -262,7 +262,7 @@ class Compiler private[japi] () {
/**
* Set the value of multiple tunable parameters
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
*
* @param tunables a map of key/value pairs, where the key is the tunable name and the value is the value to set it to
*/
Expand Down Expand Up @@ -476,7 +476,7 @@ class DataProcessor private[japi] (dp: SDataProcessor)
/**
* Read external variables from a Daffodil configuration file
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
*
* @param extVars file to read DFDL variables from.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ abstract class DebuggerRunner {
* Called by Daffodil when there is a pause in parsing to determine what
* debugger actions should be taken.
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Interactive+Debugger'>Daffodil Interactive Debugger</a> - debugger commands
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Interactive+Debugger'>Daffodil Interactive Debugger</a> - debugger commands
*
* @return a debugger command that tells the Daffodil debugger what step to
* take next.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,18 +201,14 @@ object Misc {
}

/**
* Returns a tuple with the primary version number in the first slot
* the build hash in the second slot.
* Returns the primary version of daffodil from the jar
*/
def getDaffodilVersion: Tuple2[String, String] = {
def getDaffodilVersion: String = {
val implVersion = this.getClass.getPackage.getImplementationVersion
if (implVersion == null) {
("", "")
""
} else {
val VersionRegex = """(.+)-(.+)""".r
implVersion match {
case VersionRegex(v, b) => (v, b)
}
implVersion
}
}

Expand Down
2 changes: 1 addition & 1 deletion daffodil-sapi/root-doc.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
== Daffodil Scala API ==
== Apache Daffodil (incubating) Scala API ==

=== Packages ===

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ class Compiler private[sapi] () {
/**
* Read external variables from a Daffodil configuration file
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
*
* @param extVarsFile file to read DFDL variables from.
*/
Expand All @@ -238,7 +238,7 @@ class Compiler private[sapi] () {
/**
* Set a Daffodil tunable parameter
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
*
* @param tunable name of the tunable parameter to set.
* @param value value of the tunable parameter to set
Expand All @@ -250,7 +250,7 @@ class Compiler private[sapi] () {
/**
* Set the value of multiple tunable parameters
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File#ConfigurationFile-TunableParameters'>Tunable Parameters</a> - list of tunables names of default values
*
* @param tunables a map of key/value pairs, where the key is the tunable name and the value is the value to set it to
*/
Expand Down Expand Up @@ -452,7 +452,7 @@ class DataProcessor private[sapi] (dp: SDataProcessor)
/**
* Read external variables from a Daffodil configuration file
*
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Configuration+File'>Daffodil Configuration File</a> - Daffodil configuration file format
*
* @param extVars file to read DFDL variables from.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ abstract class DebuggerRunner {
* Called by Daffodil when there is a pause in parsing to determine what
* debugger actions should be taken.
* @see <a target="_blank" href='https://opensource.ncsa.illinois.edu/confluence/display/DFDL/Interactive+Debugger'>Daffodil Interactive Debugger</a> - debugger commands
* @see <a target="_blank" href='https://cwiki.apache.org/confluence/display/DAFFODIL/Interactive+Debugger'>Daffodil Interactive Debugger</a> - debugger commands
*
* @return a debugger command that tells the Daffodil debugger what step to
* take next.
Expand Down
Loading

0 comments on commit 41a0dc7

Please sign in to comment.