Update dev guide
Project: http://git-wip-us.apache.org/repos/asf/karaf/repo Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/1954bf97 Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/1954bf97 Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/1954bf97 Branch: refs/heads/master Commit: 1954bf97460068fa2f9b40371fb6405388d5b6ed Parents: cee059c Author: Jean-Baptiste Onofré <[email protected]> Authored: Wed Jul 1 17:31:40 2015 +0200 Committer: Jean-Baptiste Onofré <[email protected]> Committed: Wed Jul 1 17:31:40 2015 +0200 ---------------------------------------------------------------------- .../webapp/developers-guide/archetypes.conf | 42 ++++++++++---------- .../main/webapp/developers-guide/branding.conf | 4 +- .../main/webapp/developers-guide/debugging.conf | 6 +-- .../developers-guide/developer-commands.conf | 17 ++++---- ...maven-plugin-features-add-to-repository.conf | 2 +- 5 files changed, 36 insertions(+), 35 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/karaf/blob/1954bf97/manual/src/main/webapp/developers-guide/archetypes.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/developers-guide/archetypes.conf b/manual/src/main/webapp/developers-guide/archetypes.conf index 1650714..be8bc1e 100644 --- a/manual/src/main/webapp/developers-guide/archetypes.conf +++ b/manual/src/main/webapp/developers-guide/archetypes.conf @@ -16,7 +16,7 @@ Using the command line, we can create our project: mvn archetype:generate \ -DarchetypeGroupId=org.apache.karaf.archetypes \ -DarchetypeArtifactId=karaf-command-archetype \ - -DarchetypeVersion=${project.version} \ + -DarchetypeVersion=4.0.0 \ -DgroupId=com.mycompany \ -DartifactId=com.mycompany.command \ -Dversion=1.0-SNAPSHOT \ @@ -50,7 +50,7 @@ h3. Result of Maven command execution [INFO] [INFO] --- maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom --- [INFO] Generating project in Interactive mode -[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-command-archetype:${project.version}] found in catalog local +[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-command-archetype:4.0.0] found in catalog local [INFO] Using property: groupId = com.mycompany [INFO] Using property: artifactId = com.mycompany.command [INFO] Using property: version = 1.0-SNAPSHOT @@ -68,7 +68,7 @@ description: List sample command scope: my Y: : [INFO] ---------------------------------------------------------------------------- -[INFO] Using following parameters for creating project from Archetype: karaf-command-archetype:${project.version} +[INFO] Using following parameters for creating project from Archetype: karaf-command-archetype:4.0.0 [INFO] ---------------------------------------------------------------------------- [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.command @@ -82,8 +82,8 @@ scope: my [INFO] Parameter: description, Value: List sample command [INFO] Parameter: command, Value: list [INFO] Parameter: artifactId, Value: com.mycompany.command -[WARNING] Don't override file /home/jbonofre/workspace/karaf/test/com.mycompany.command/pom.xml -[INFO] project created from Archetype in dir: /home/jbonofre/workspace/karaf/test/com.mycompany.command +[WARNING] Don't override file /com.mycompany.command/pom.xml +[INFO] project created from Archetype in dir: /com.mycompany.command [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ @@ -106,7 +106,7 @@ Using the command line, we can create our project: mvn archetype:generate \ -DarchetypeGroupId=org.apache.karaf.archetypes \ -DarchetypeArtifactId=karaf-bundle-archetype \ - -DarchetypeVersion=${project.version} \ + -DarchetypeVersion=4.0.0 \ -DgroupId=com.mycompany \ -DartifactId=com.mycompany.bundle \ -Dversion=1.0-SNAPSHOT \ @@ -128,7 +128,7 @@ h3. Result of Maven command execution [INFO] [INFO] --- maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom --- [INFO] Generating project in Interactive mode -[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-bundle-archetype:${project.version}] found in catalog local +[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-bundle-archetype:4.0.0] found in catalog local [INFO] Using property: groupId = com.mycompany [INFO] Using property: artifactId = com.mycompany.bundle [INFO] Using property: version = 1.0-SNAPSHOT @@ -140,7 +140,7 @@ version: 1.0-SNAPSHOT package: com.mycompany.package Y: : [INFO] ---------------------------------------------------------------------------- -[INFO] Using following parameters for creating project from Archetype: karaf-bundle-archetype:${project.version} +[INFO] Using following parameters for creating project from Archetype: karaf-bundle-archetype:4.0.0 [INFO] ---------------------------------------------------------------------------- [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.bundle @@ -151,7 +151,7 @@ package: com.mycompany.package [INFO] Parameter: version, Value: 1.0-SNAPSHOT [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.bundle -[INFO] project created from Archetype in dir: /home/jbonofre/workspace/karaf/test/com.mycompany.bundle +[INFO] project created from Archetype in dir: /com.mycompany.bundle [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ @@ -172,7 +172,7 @@ Using the command line, we can create our project: mvn archetype:generate \ -DarchetypeGroupId=org.apache.karaf.archetypes \ -DarchetypeArtifactId=karaf-blueprint-archetype \ - -DarchetypeVersion=${project.version} \ + -DarchetypeVersion=4.0.0 \ -DgroupId=com.mycompany \ -DartifactId=com.mycompany.blueprint \ -Dversion=1.0-SNAPSHOT \ @@ -194,7 +194,7 @@ h3. Result of Maven command execution [INFO] [INFO] --- maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom --- [INFO] Generating project in Interactive mode -[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-blueprint-archetype:${project.version}] found in catalog local +[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-blueprint-archetype:4.0.0] found in catalog local [INFO] Using property: groupId = com.mycompany [INFO] Using property: artifactId = com.mycompany.blueprint [INFO] Using property: version = 1.0-SNAPSHOT @@ -206,7 +206,7 @@ version: 1.0-SNAPSHOT package: com.mycompany.package Y: : [INFO] ---------------------------------------------------------------------------- -[INFO] Using following parameters for creating project from Archetype: karaf-blueprint-archetype:${project.version} +[INFO] Using following parameters for creating project from Archetype: karaf-blueprint-archetype:4.0.0 [INFO] ---------------------------------------------------------------------------- [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.blueprint @@ -217,7 +217,7 @@ package: com.mycompany.package [INFO] Parameter: version, Value: 1.0-SNAPSHOT [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.blueprint -[INFO] project created from Archetype in dir: /home/jbonofre/workspace/karaf/test/com.mycompany.blueprint +[INFO] project created from Archetype in dir: /com.mycompany.blueprint [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ @@ -238,7 +238,7 @@ Using the command line, we can create our project: mvn archetype:generate \ -DarchetypeGroupId=org.apache.karaf.archetypes \ -DarchetypeArtifactId=karaf-feature-archetype \ - -DarchetypeVersion=${project.version} \ + -DarchetypeVersion=4.0.0 \ -DgroupId=my.company \ -DartifactId=my.company.feature \ -Dversion=1.0-SNAPSHOT \ @@ -260,7 +260,7 @@ h3. Result of maven command execution [INFO] [INFO] --- maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom --- [INFO] Generating project in Interactive mode -[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-feature-archetype:${project.version}] found in catalog local +[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-feature-archetype:4.0.0] found in catalog local [INFO] Using property: groupId = com.mycompany [INFO] Using property: artifactId = com.mycompany.feature [INFO] Using property: version = 1.0-SNAPSHOT @@ -272,7 +272,7 @@ version: 1.0-SNAPSHOT package: com.mycompany.package Y: : [INFO] ---------------------------------------------------------------------------- -[INFO] Using following parameters for creating project from Archetype: karaf-feature-archetype:${project.version} +[INFO] Using following parameters for creating project from Archetype: karaf-feature-archetype:4.0.0 [INFO] ---------------------------------------------------------------------------- [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.feature @@ -283,7 +283,7 @@ package: com.mycompany.package [INFO] Parameter: version, Value: 1.0-SNAPSHOT [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.feature -[INFO] project created from Archetype in dir: /home/jbonofre/workspace/karaf/test/com.mycompany.feature +[INFO] project created from Archetype in dir: /com.mycompany.feature [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ @@ -304,7 +304,7 @@ Using the command line, we can create our project: mvn archetype:generate \ -DarchetypeGroupId=org.apache.karaf.archetypes \ -DarchetypeArtifactId=karaf-kar-archetype \ - -DarchetypeVersion=${project.version} \ + -DarchetypeVersion=4.0.0 \ -DgroupId=com.mycompany \ -DartifactId=com.mycompany.kar \ -Dversion=1.0-SNAPSHOT \ @@ -326,7 +326,7 @@ h3. Result of maven command execution [INFO] [INFO] --- maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom --- [INFO] Generating project in Interactive mode -[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-kar-archetype:${project.version}] found in catalog local +[INFO] Archetype repository missing. Using the one from [org.apache.karaf.archetypes:karaf-kar-archetype:4.0.0] found in catalog local [INFO] Using property: groupId = com.mycompany [INFO] Using property: artifactId = com.mycompany.kar [INFO] Using property: version = 1.0-SNAPSHOT @@ -338,7 +338,7 @@ version: 1.0-SNAPSHOT package: com.mycompany.package Y: : [INFO] ---------------------------------------------------------------------------- -[INFO] Using following parameters for creating project from Archetype: karaf-kar-archetype:${project.version} +[INFO] Using following parameters for creating project from Archetype: karaf-kar-archetype:4.0.0 [INFO] ---------------------------------------------------------------------------- [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.kar @@ -349,7 +349,7 @@ package: com.mycompany.package [INFO] Parameter: version, Value: 1.0-SNAPSHOT [INFO] Parameter: groupId, Value: com.mycompany [INFO] Parameter: artifactId, Value: com.mycompany.kar -[INFO] project created from Archetype in dir: /home/jbonofre/workspace/karaf/test/com.mycompany.kar +[INFO] project created from Archetype in dir: /com.mycompany.kar [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ http://git-wip-us.apache.org/repos/asf/karaf/blob/1954bf97/manual/src/main/webapp/developers-guide/branding.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/developers-guide/branding.conf b/manual/src/main/webapp/developers-guide/branding.conf index 5932199..c0f16aa 100644 --- a/manual/src/main/webapp/developers-guide/branding.conf +++ b/manual/src/main/webapp/developers-guide/branding.conf @@ -23,7 +23,7 @@ welcome = \ \u001B[36m / /| |/ /_/ / / / /_/ / __/ \u001B[0m\r\n\ \u001B[36m /_/ |_|\\__,_/_/ \\__,_/_/ \u001B[0m\r\n\ \r\n\ -\u001B[1m Apache Karaf\u001B[0m (${project.version})\r\n\ +\u001B[1m Apache Karaf\u001B[0m (4.0.0)\r\n\ \r\n\ Hit '\u001B[1m<tab>\u001B[0m' for a list of available commands\r\n\ and '\u001B[1m[cmd] --help\u001B[0m' for help on a specific command.\r\n\ @@ -139,7 +139,7 @@ mvn install You just have to drop the file in the {{lib}} directory: {code} -cp branding.jar /opt/apache-karaf-3.0.0/lib/karaf-branding.jar +cp branding.jar /opt/apache-karaf-4.0.0/lib/karaf-branding.jar {code} You can now start Apache Karaf to see your branded console. http://git-wip-us.apache.org/repos/asf/karaf/blob/1954bf97/manual/src/main/webapp/developers-guide/debugging.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/developers-guide/debugging.conf b/manual/src/main/webapp/developers-guide/debugging.conf index 3742c6d..5f64009 100644 --- a/manual/src/main/webapp/developers-guide/debugging.conf +++ b/manual/src/main/webapp/developers-guide/debugging.conf @@ -34,11 +34,11 @@ Remote debugging can be easily activated by using the {{debug}} parameter on the {noformat} > bin/karaf debug -{noformat +{noformat} or on Windows {noformat} > bin\karaf.bat debug -{noformat +{noformat} Another option is to set the {{KARAF_DEBUG}} environment variable to {{TRUE}}. @@ -151,4 +151,4 @@ allowing you to create, rename, destroy, change SSH port, etc. Karaf instances: You can also manage Karaf features MBean to list, install, and uninstall Karaf features: -!/images/jconsole_features.jpg|border=1! \ No newline at end of file +!/images/jconsole_features.jpg|border=1! http://git-wip-us.apache.org/repos/asf/karaf/blob/1954bf97/manual/src/main/webapp/developers-guide/developer-commands.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/developers-guide/developer-commands.conf b/manual/src/main/webapp/developers-guide/developer-commands.conf index bc1a688..e442530 100644 --- a/manual/src/main/webapp/developers-guide/developer-commands.conf +++ b/manual/src/main/webapp/developers-guide/developer-commands.conf @@ -13,10 +13,11 @@ about the current activity of the container. The {{dev:dump-create}} command creates a dump file containing: * the {{bundles.txt}} file contains the list of all OSGi bundles, with id, symbolic name, version, current status +* the {{features.txt}} file contains the list of all features, including current status * the {{environment.txt}} file contains details about Apache Karaf, OSGi framework, Operating System, JVM, system properties, threads count, classes loaded -* the {{features.txt}} file contains the list of Apache Karaf features repositories, features with version, current - status, and bundles provided. +* the {{memory.txt}} file contains the status of the JVM memory at the dump time +* the {{heapdump.txt}} file contains a memory heap dump, with all objects instances, space usage, etc. * the {{threads.txt}} file contains a thread dump, with all threads, waiting status, etc. * the {{log}} folder contains the {{data/log}} folder, with all log files. @@ -25,15 +26,15 @@ dump creation: {code} karaf@root()> dev:dump-create -Diagnostic dump created. +Created dump zip: 2015-07-01_171434.zip {code} We can see the file generated in the {{KARAF_BASE}} folder: {code} -$ cd /opt/apache-karaf-3.0.0 +$ cd /opt/apache-karaf-4.0.0 $ ls -lh *.zip --rw-r--r-- 1 user group 11K Dec 23 16:08 2013-12-23_160858.zip +-rw-rw-r-- 1 user group 17M Jul 1 17:14 2015-07-01_171434.zip {code} You can specify the file name of the zip archive: @@ -98,8 +99,8 @@ h2. Dynamic import The {{bundle:dynamic-import}} command allows you to enable or disable the dynamic import of a given bundle: {code} -karaf@root()> bundle:dynamic-import 77 -Enabling dynamic imports on bundle org.apache.karaf.config.core [77] +karaf@root()> bundle:dynamic-import 50 +Enabling dynamic imports on bundle org.ops4j.pax.url.wrap [50] {code} The purpose of dynamic import is to allow a bundle to be wired up to packages that may not be knwon about in advance. @@ -221,7 +222,7 @@ Only Maven based URLs and Maven SNAPSHOTs will actually be updated automatically The following command: {code} -karaf@root> dev:watch * +karaf@root()> bundle:watch * {code} will monitor all bundles that have a location matching mvn:* and '-SNAPSHOT' in their URL. http://git-wip-us.apache.org/repos/asf/karaf/blob/1954bf97/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf ---------------------------------------------------------------------- diff --git a/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf b/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf index 54e02db..b2720cd 100644 --- a/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf +++ b/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf @@ -26,7 +26,7 @@ The example below copies the bundles for the {{spring}} and {{war}} features def </goals> <configuration> <descriptors> - <descriptor>mvn:org.apache.karaf.features/standard/3.0.0/xml/features</descriptor> + <descriptor>mvn:org.apache.karaf.features/standard/4.0.0/xml/features</descriptor> <descriptor>mvn:my.groupid/my.artifactid/1.0.0/xml/features</descriptor> </descriptors> <features>
