This is an automated email from the ASF dual-hosted git repository. cbrisson pushed a commit to branch engine-2.4 in repository https://gitbox.apache.org/repos/asf/velocity-site.git
commit 06e313d5a785cb13d994de79c19e08cecb4aef48 Author: Claude Brisson <[email protected]> AuthorDate: Fri Aug 23 18:34:28 2024 +0200 Backport missing changes from the 2.3 doc to the devel doc --- src/content/engine/devel/dependencies.mdtext | 8 ++++---- src/content/engine/devel/developer-guide.mdtext | 2 ++ src/content/engine/devel/getting-started.mdtext | 19 ++++--------------- 3 files changed, 10 insertions(+), 19 deletions(-) diff --git a/src/content/engine/devel/dependencies.mdtext b/src/content/engine/devel/dependencies.mdtext index 40cd640..3d0f653 100644 --- a/src/content/engine/devel/dependencies.mdtext +++ b/src/content/engine/devel/dependencies.mdtext @@ -11,10 +11,10 @@ The following table lists all needed jars. Jar name | Version | Compilation | Tests | Runtime | Comment ---------|---------|---------|-------|-------------|-------- slf4j-api | 1.7.30 | Yes | Yes | Yes | you'll also need an slf4j binding at runtime -commons-lang | 3.8.1 | Yes | Yes | Yes | -junit | 4.13 | No | Yes | No | -hsqldb | 2.5.0 | No | Yes | No | -commons-io | 2.6 | No | Yes | No | +commons-lang | 3.11 | Yes | Yes | Yes | +junit | 4.13.2 | No | Yes | No | +hsqldb | 2.5.1 | No | Yes | No | +commons-io | 2.8.0 | No | Yes | No | slf4j-simple | 1.7.30 | No | Yes | No | Your application will need *one* SLF4J binding, see below Here is a list of slf4j bindings: diff --git a/src/content/engine/devel/developer-guide.mdtext b/src/content/engine/devel/developer-guide.mdtext index 90127c4..a196e0b 100644 --- a/src/content/engine/devel/developer-guide.mdtext +++ b/src/content/engine/devel/developer-guide.mdtext @@ -1044,6 +1044,8 @@ Here is the list of provided uberspectors (which are found in the [`org.apache.v > A Chainable uberspector is an uberspector that wraps the previous > uberspector in the introspection chain. - [LinkingUberspector](apidocs/org/apache/velocity/util/introspection/LinkingUberspector.html) > The Linking uberspector is meant for internal use only. It provides > introspection chaining when the left uberspector of two following > uberspectors of the introspection chain is not a ChainableUberspector. It > first tries to delegate introspection to the left uberspector, and only > calls the right one in case of failure. +- [UberspectLoggable](apidocs/org/apache/velocity/util/introspection/UberspectLoggable.html) interface +> When an uberspector implements the UberspectLoggable interface, it is provided a logger during initialization via the `setLog(Logger)` method. If an Uberspector implements the [RuntimeServicesAware](apidocs/org/apache/velocity/util/RuntimeServicesAware.html) interface, it will be provided a Velocity [RuntimeServices](apidocs/org/apache/velocity/runtime/RuntimeServices.html) instance during initialization, via the `setRuntimeServices(RuntimeServices)` method. diff --git a/src/content/engine/devel/getting-started.mdtext b/src/content/engine/devel/getting-started.mdtext index c5a9398..8fbc2c8 100644 --- a/src/content/engine/devel/getting-started.mdtext +++ b/src/content/engine/devel/getting-started.mdtext @@ -13,23 +13,12 @@ The best place to start is with the examples provided in the distribution, and w ## Downloading Velocity -You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. +You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. -If you want to download the [latest source](source-repository.html), you can do so via the git source control system. +If you want to download the latest source, you can do so using git, see the [downloads page](/download.cgi). -You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). - -Instructions for building Velocity from source can be found in the [Build](build.html) document. +Instructions for building Velocity from source can be found in the [Site Building](build.html) document. ## API Documentation -Our API documentation is available [online](apidocs/), as part of the distribution package, an of course, you can generate it yourself from the included source code. - -If you would like to create a full set of detailed API documentation for Velocity, go to the `build` directory and run: - - :::shell - ant javadocs - -The docs will be found in the `/bin/apidocs/` directory. - -**Note:** Velocity uses the [Maven](http://maven.Apache.org) build tool for all code and documentation generation, so you will need to have it installed. +Our API documentation is available [online](apidocs/), you can generate it yourself from the included source code using the `mvn javadoc:aggregate` command.
