You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2015/12/24 08:29:00 UTC
karaf-cave git commit: KARAF-3679 - Fix typo in Cave documentation
Repository: karaf-cave
Updated Branches:
refs/heads/master cc16344b7 -> f6098ba1a
KARAF-3679 - Fix typo in Cave documentation
Project: http://git-wip-us.apache.org/repos/asf/karaf-cave/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf-cave/commit/f6098ba1
Tree: http://git-wip-us.apache.org/repos/asf/karaf-cave/tree/f6098ba1
Diff: http://git-wip-us.apache.org/repos/asf/karaf-cave/diff/f6098ba1
Branch: refs/heads/master
Commit: f6098ba1af4b83178f7ed579518b5f0e9a878e80
Parents: cc16344
Author: Jean-Baptiste Onofré <jb...@apache.org>
Authored: Thu Dec 24 08:28:39 2015 +0100
Committer: Jean-Baptiste Onofré <jb...@apache.org>
Committed: Thu Dec 24 08:28:39 2015 +0100
----------------------------------------------------------------------
.../main/asciidoc/user-guide/administrate-cave.adoc | 2 +-
.../src/main/asciidoc/user-guide/cave-repository.adoc | 14 +++++++-------
manual/src/main/asciidoc/user-guide/installation.adoc | 3 ++-
.../main/asciidoc/user-guide/populate-repository.adoc | 4 ++--
.../main/asciidoc/user-guide/proxy-repository.adoc | 4 ++--
5 files changed, 14 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/f6098ba1/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/administrate-cave.adoc b/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
index 92663b6..6e5eb8d 100644
--- a/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
+++ b/manual/src/main/asciidoc/user-guide/administrate-cave.adoc
@@ -24,7 +24,7 @@ This MBean uses the following object name:
org.apache.karaf.cave:type=repository,name=*
----
-Thanks to this MBean, using any JMX client (like jconsole for instance), you can do all actions as you can using the 'cave:*' commands:
+Thanks to this MBean, using any JMX client (like jconsole for instance), you can do all actions as you can using the `cave:*` commands:
* void createRepository(String name, String location, boolean generate, boolean install) throws Exception;
* void destroyRepository(String name) throws Exception;
http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/f6098ba1/manual/src/main/asciidoc/user-guide/cave-repository.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/cave-repository.adoc b/manual/src/main/asciidoc/user-guide/cave-repository.adoc
index f4a4448..12f242e 100644
--- a/manual/src/main/asciidoc/user-guide/cave-repository.adoc
+++ b/manual/src/main/asciidoc/user-guide/cave-repository.adoc
@@ -49,42 +49,42 @@ You can change the storage location in the 'etc/org.apache.karaf.cave.server.sto
cave.storage.location=cave
----
-For instance, you can define '/var/cave/store' for the 'storage.location' property.
+For instance, you can define `/var/cave/store` for the `storage.location` property.
=== Create
-The 'cave:repository-create' command creates a new repository:
+The `cave:repository-create` command creates a new repository:
----
karaf@root()> cave:repository-create my-repository
----
-A repository is identified by a name, 'my-repository' in our example.
+A repository is identified by a name, `my-repository` in our example.
Apache Karaf Cave creates the repository storage for you.
-If you want to use an existing directory, and avoid Cave to create one in the storage location, you can use the '-l'
+If you want to use an existing directory, and avoid Cave to create one in the storage location, you can use the `-l`
('--location') option:
----
karaf@root()> cave:repository-create -l /home/user/.m2/repository m2
----
-By default, Apache Karaf Cave scans the repository storage and create the repository metadata. You can use the '-no' ('--no-generate')
+By default, Apache Karaf Cave scans the repository storage and create the repository metadata. You can use the `-no` (`--no-generate`)
option to avoid this step:
----
karaf@root()> cave:repository-create -no -l /home/user/.m2/repository m2
----
-By default, Apache Karaf Cave registers (installs) a new repository into the repository service. You can use the '-ns' ('--no-start')
+By default, Apache Karaf Cave registers (installs) a new repository into the repository service. You can use the `-ns` (`--no-start`)
option to avoid this step:
----
karaf@root()> cave:repository-create -ns -l /home/user/m2/repository m2
----
-NB: the '-no' and '-ni' options are interesting when you use an existing location for the repository. If you create a
+NB: the `-no` and `-ni` options are interesting when you use an existing location for the repository. If you create a
new empty repository, these options don't have really any effect.
=== List
http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/f6098ba1/manual/src/main/asciidoc/user-guide/installation.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/installation.adoc b/manual/src/main/asciidoc/user-guide/installation.adoc
index 5062010..0f23e94 100644
--- a/manual/src/main/asciidoc/user-guide/installation.adoc
+++ b/manual/src/main/asciidoc/user-guide/installation.adoc
@@ -45,7 +45,7 @@ cave-rest | 4.0.0 | | Uninstall
cave-maven | 4.0.0 | | Uninstalled | karaf-cave-4.0.0 |
----
-h3. Starting Apache Karaf Cave Server
+=== Starting Apache Karaf Cave Server
The Apache Karaf Cave Server is installed by the 'cave-server' feature:
@@ -54,6 +54,7 @@ karaf@root()> feature:install cave-server
----
The cave-server feature is a meta-feature which actually installs:
+
* cave-storage feature providing the Cave filesystem default storage.
* cave-http feature providing the Cave HTTP service allowing a remote access to the repositories.
* cave-rest feature providing the Cave REST API allowing to manipulate the repository remotely with any REST HTTP client.
http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/f6098ba1/manual/src/main/asciidoc/user-guide/populate-repository.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/populate-repository.adoc b/manual/src/main/asciidoc/user-guide/populate-repository.adoc
index 1fa62f7..f097e82 100644
--- a/manual/src/main/asciidoc/user-guide/populate-repository.adoc
+++ b/manual/src/main/asciidoc/user-guide/populate-repository.adoc
@@ -39,7 +39,7 @@ You can also make a kind of "bulk" population of your repository, using an exter
karaf@root()> cave:repository-populate my-repository file:/home/user/.m2/repository
----
-Apache Karaf Cave supports 'file:' but also 'http:' URL. It means that Apache Karaf Cave is able to browse a remote repository and copy the artifacts
+Apache Karaf Cave supports `file:` but also `http:` URL. It means that Apache Karaf Cave is able to browse a remote repository and copy the artifacts
in your "local" repository.
For instance, you can populate your repository using all Ant ServiceMix bundles present on the Central Maven
@@ -58,7 +58,7 @@ karaf@root()> cave:repository-populate my-repository http://repo1.maven.org/mave
Maven Central repository is really huge and populating from the whole Maven Central Repository will take
very very long time. It's just for demonstration purpose.
-You can filter the artifacts that you want to pick up to populate the repository. The 'cave:repository-populate' command accepts
+You can filter the artifacts that you want to pick up to populate the repository. The `cave:repository-populate` command accepts
a regex option for the filter. For instance, to pick up only joda-time version 2 artifact, you can run:
----
http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/f6098ba1/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/user-guide/proxy-repository.adoc b/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
index 49b6040..cbd4971 100644
--- a/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
+++ b/manual/src/main/asciidoc/user-guide/proxy-repository.adoc
@@ -24,11 +24,11 @@ karaf@root()> cave:repository-proxy my-repository http://repo1.maven.org/maven2/
----
NB: the Cave repository will only handle the repository metadata, it doesn't monitor the remote repository. It means that you
-have to call the 'cave:proxy-repository' command each time the remote repository change (new artifacts, etc).
+have to call the `cave:proxy-repository` command each time the remote repository change (new artifacts, etc).
NB: a best practice is to create a Cave repository dedicated for each proxied repository.
-The 'cave:repository-proxy' command accepts the filter option, as the 'cave:repository-populate' command:
+The `cave:repository-proxy` command accepts the filter option, as the `cave:repository-populate` command:
----
karaf@root()> cave:repository-proxy --filter .*joda-time-2.* my-repository http://repo2.maven.org/maven2/joda-time/joda-time