This is an automated email from the ASF dual-hosted git repository.
mwalch pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git
The following commit(s) were added to refs/heads/master by this push:
new f18e10f All Accumulo package prefixes work with javadoc links (#96)
f18e10f is described below
commit f18e10f5267f34d1a4b7a1dfac72ab46132b39d5
Author: Mike Walch <mwa...@apache.org>
AuthorDate: Wed Jul 11 12:19:58 2018 -0400
All Accumulo package prefixes work with javadoc links (#96)
* Updated documentation
---
_docs-2-0/development/summaries.md | 14 ++++++--------
_docs-2-0/getting-started/table_configuration.md | 9 ++++-----
_plugins/links.rb | 17 ++++++++++-------
3 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/_docs-2-0/development/summaries.md
b/_docs-2-0/development/summaries.md
index d59a650..04eb8b3 100644
--- a/_docs-2-0/development/summaries.md
+++ b/_docs-2-0/development/summaries.md
@@ -21,10 +21,9 @@ for this to be fast the, summary information should fit in
cache. There is a
dedicated cache for summary data on each tserver with a configurable size. In
order for summary data to fit in cache, it should probably be small.
-For information on writing a custom summarizer see the javadoc for
-`org.apache.accumulo.core.client.summary.Summarizer`. The package
-`org.apache.accumulo.core.client.summary.summarizers` contains summarizer
-implementations that ship with Accumulo and can be configured for use.
+For information on writing a custom summarizer see the javadoc of the {% jlink
org.apache.accumulo.core.client.summary.Summarizer %}
+class. The package {% jlink
org.apache.accumulo.core.client.summary.summarizers %}
+contains summarizer implementations that ship with Accumulo and can be
configured for use.
## Inaccuracies
@@ -63,11 +62,10 @@ requires a special permission. User must have the table
permission
## Bulk import
-When generating rfiles to bulk import into Accumulo, those rfiles can contain
+When generating RFiles to bulk import into Accumulo, those RFiles can contain
summary data. To use this feature, look at the javadoc on the
-`AccumuloFileOutputFormat.setSummarizers(...)` method. Also,
-`org.apache.accumulo.core.client.rfile.RFile` has options for creating RFiles
-with embedded summary data.
+`AccumuloFileOutputFormat.setSummarizers(...)` method. Also, the {% jlink
org.apache.accumulo.core.client.rfile.RFile %}
+class has options for creating RFiles with embedded summary data.
## Examples
diff --git a/_docs-2-0/getting-started/table_configuration.md
b/_docs-2-0/getting-started/table_configuration.md
index 7d151a8..aea6186 100644
--- a/_docs-2-0/getting-started/table_configuration.md
+++ b/_docs-2-0/getting-started/table_configuration.md
@@ -417,7 +417,7 @@ This will only compact tablets that overlap the given row
range.
### Compaction Strategies
-The default behavior of major compactions is defined in the class
DefaultCompactionStrategy.
+The default behavior of major compactions is defined in the class {% jlink
org.apache.accumulo.tserver.compaction.DefaultCompactionStrategy %}.
This behavior can be changed by overriding [table.majc.compaction.strategy]
with a fully
qualified class name.
@@ -426,11 +426,10 @@ Custom compaction strategies can have additional
properties that are specified f
table.majc.compaction.strategy.opts.*
Accumulo provides a few classes that can be used as an alternative compaction
strategy. These classes are located in the
-`org.apache.accumulo.tserver.compaction.*` package.
`EverythingCompactionStrategy` will simply compact all files. This is the
-strategy used by the user `compact` command. `SizeLimitCompactionStrategy`
compacts files no bigger than the limit set in the
-property `table.majc.compaction.strategy.opts.sizeLimit`.
+{% jlink -f org.apache.accumulo.tserver.compaction %} package. {% jlink
org.apache.accumulo.tserver.compaction.EverythingCompactionStrategy %}
+will simply compact all files. This is the strategy used by the user `compact`
command. {% jlink
org.apache.accumulo.tserver.compaction.SizeLimitCompactionStrategy %} compacts
files no bigger than the limit set in the property
`table.majc.compaction.strategy.opts.sizeLimit`.
-`TwoTierCompactionStrategy` is a hybrid compaction strategy that supports two
types of compression. If the total size of
+{% jlink org.apache.accumulo.tserver.compaction.TwoTierCompactionStrategy %}
is a hybrid compaction strategy that supports two types of compression. If the
total size of
files being compacted is larger than
`table.majc.compaction.strategy.opts.file.large.compress.threshold` than a
larger
compression type will be used. The larger compression type is specified in
`table.majc.compaction.strategy.opts.file.large.compress.type`.
Otherwise, the configured table compression will be used. To use this strategy
with minor compactions set [table.file.compress.type] to `snappy`
diff --git a/_plugins/links.rb b/_plugins/links.rb
index 7757358..2c00279 100755
--- a/_plugins/links.rb
+++ b/_plugins/links.rb
@@ -35,15 +35,18 @@ def render_javadoc(context, text, url_only)
clz_slash = convert_package(clz)
clz_name = clz.split('.').last
- jmodule = 'unknown'
- if clz.start_with?('org.apache.accumulo.core')
- jmodule = 'accumulo-core'
+ if not clz.start_with?('org.apache.accumulo.')
+ raise "Unknown package prefix for #{clz}"
+ end
+
+ # Default is accumulo-<module> but handle corner cases below
+ jmodule = 'accumulo-' + clz.split('.')[3]
+ if clz.start_with?('org.apache.accumulo.server')
+ jmodule = 'accumulo-server-base'
+ elsif clz.start_with?('org.apache.accumulo.core.client.mapred')
+ jmodule = 'accumulo-client-mapreduce'
elsif clz.start_with?('org.apache.accumulo.iteratortest')
jmodule = 'accumulo-iterator-test-harness'
- elsif clz.start_with?('org.apache.accumulo.minicluster')
- jmodule = 'accumulo-minicluster'
- else
- raise "Unknown package prefix for #{clz}"
end
if clz_slash.include? "#"
