You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ho...@apache.org on 2017/05/09 23:40:38 UTC
[2/2] lucene-solr:jira/solr-10290: SOLR-10655: add TODO comments
noting content that should be refactored into include snippets
SOLR-10655: add TODO comments noting content that should be refactored into include snippets
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/ccebeecd
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/ccebeecd
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/ccebeecd
Branch: refs/heads/jira/solr-10290
Commit: ccebeecd1e432f87f50bb98a18496fe7cad3688f
Parents: 04bf430
Author: Chris Hostetter <ho...@apache.org>
Authored: Tue May 9 16:40:28 2017 -0700
Committer: Chris Hostetter <ho...@apache.org>
Committed: Tue May 9 16:40:28 2017 -0700
----------------------------------------------------------------------
solr/solr-ref-guide/src/collection-specific-tools.adoc | 2 ++
solr/solr-ref-guide/src/core-specific-tools.adoc | 4 ++++
solr/solr-ref-guide/src/defining-fields.adoc | 5 +++++
.../src/field-type-definitions-and-properties.adoc | 4 ++++
.../src/using-the-solr-administration-user-interface.adoc | 4 ++++
5 files changed, 19 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ccebeecd/solr/solr-ref-guide/src/collection-specific-tools.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/collection-specific-tools.adoc b/solr/solr-ref-guide/src/collection-specific-tools.adoc
index 47188e5..b94572a 100644
--- a/solr/solr-ref-guide/src/collection-specific-tools.adoc
+++ b/solr/solr-ref-guide/src/collection-specific-tools.adoc
@@ -19,6 +19,7 @@ image::images/collection-specific-tools/collection_dashboard.png[image,width=482
The collection-specific UI screens are listed below, with a link to the section of this guide to find out more:
+// TODO: SOLR-10655 BEGIN: refactor this into a 'collection-screens-list.include.adoc' file for reuse
* <<analysis-screen.adoc#analysis-screen,Analysis>> - lets you analyze the data found in specific fields.
* <<dataimport-screen.adoc#dataimport-screen,Dataimport>> - shows you information about the current status of the Data Import Handler.
* <<documents-screen.adoc#documents-screen,Documents>> - provides a simple form allowing you to execute various Solr indexing commands directly from the browser.
@@ -26,3 +27,4 @@ The collection-specific UI screens are listed below, with a link to the section
* <<query-screen.adoc#query-screen,Query>> - lets you submit a structured query about various elements of a core.
* <<stream-screen.adoc#stream-screen,Stream>> - allows you to submit streaming expressions and see results and parsing explanations.
* <<schema-browser-screen.adoc#schema-browser-screen,Schema Browser>> - displays schema data in a browser window.
+// TODO: SOLR-10655 END
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ccebeecd/solr/solr-ref-guide/src/core-specific-tools.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/core-specific-tools.adoc b/solr/solr-ref-guide/src/core-specific-tools.adoc
index 86cd734..54144c5 100644
--- a/solr/solr-ref-guide/src/core-specific-tools.adoc
+++ b/solr/solr-ref-guide/src/core-specific-tools.adoc
@@ -16,13 +16,16 @@ image::images/core-specific-tools/core_dashboard.png[image,width=515,height=250]
The core-specific UI screens are listed below, with a link to the section of this guide to find out more:
+// TODO: SOLR-10655 BEGIN: refactor this into a 'core-screens-list.include.adoc' file for reuse
* <<ping.adoc#ping,Ping>> - lets you ping a named core and determine whether the core is active.
* <<plugins-stats-screen.adoc#plugins-stats-screen,Plugins/Stats>> - shows statistics for plugins and other installed components.
* <<replication-screen.adoc#replication-screen,Replication>> - shows you the current replication status for the core, and lets you enable/disable replication.
* <<segments-info.adoc#segments-info,Segments Info>> - Provides a visualization of the underlying Lucene index segments.
+// TODO: SOLR-10655 END
If you are running a single node instance of Solr, additional UI screens normally displayed on a per-collection bases will also be listed:
+// TODO: SOLR-10655 BEGIN: refactor this into a 'collection-screens-list.include.adoc' file for reuse
* <<analysis-screen.adoc#analysis-screen,Analysis>> - lets you analyze the data found in specific fields.
* <<dataimport-screen.adoc#dataimport-screen,Dataimport>> - shows you information about the current status of the Data Import Handler.
* <<documents-screen.adoc#documents-screen,Documents>> - provides a simple form allowing you to execute various Solr indexing commands directly from the browser.
@@ -30,3 +33,4 @@ If you are running a single node instance of Solr, additional UI screens normall
* <<query-screen.adoc#query-screen,Query>> - lets you submit a structured query about various elements of a core.
* <<stream-screen.adoc#stream-screen,Stream>> - allows you to submit streaming expressions and see results and parsing explanations.
* <<schema-browser-screen.adoc#schema-browser-screen,Schema Browser>> - displays schema data in a browser window.
+// TODO: SOLR-10655 END
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ccebeecd/solr/solr-ref-guide/src/defining-fields.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/defining-fields.adoc b/solr/solr-ref-guide/src/defining-fields.adoc
index ed5e665..15dba12 100644
--- a/solr/solr-ref-guide/src/defining-fields.adoc
+++ b/solr/solr-ref-guide/src/defining-fields.adoc
@@ -32,6 +32,8 @@ The following example defines a field named `price` with a type named `float` an
Fields can have many of the same properties as field types. Properties from the table below which are specified on an individual field will override any explicit value for that property specified on the the `fieldType` of the field, or any implicit default property value provided by the underlying `fieldType` implementation. The table below is reproduced from <<field-type-definitions-and-properties.adoc#field-type-definitions-and-properties,Field Type Definitions and Properties>>, which has more details:
+// TODO: SOLR-10655 BEGIN: refactor this into a 'field-default-properties.include.adoc' file for reuse
+
// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
[cols="20,40,20,20",options="header"]
@@ -50,3 +52,6 @@ Fields can have many of the same properties as field types. Properties from the
|useDocValuesAsStored |If the field has `<<docvalues.adoc#docvalues,docValues>>` enabled, setting this to true would allow the field to be returned as if it were a stored field (even if it has `stored=false`) when matching "`*`" in an <<common-query-parameters.adoc#CommonQueryParameters-Thefl_FieldList_Parameter,fl parameter>>. |true or false |true
|large |Large fields are always lazy loaded and will only take up space in the document cache if the actual value is < 512KB. This option requires `stored="true"` and `multiValued="false"`. It's intended for fields that might have very large values so that they don't get cached in memory. |true or false |false
|===
+
+// TODO: SOLR-10655 END
+
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ccebeecd/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc b/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
index 01bfe11..df06657 100644
--- a/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
+++ b/solr/solr-ref-guide/src/field-type-definitions-and-properties.adoc
@@ -84,6 +84,8 @@ These are properties that can be specified either on the field types, or on indi
The default values for each property depend on the underlying `FieldType` class, which in turn may depend on the `version` attribute of the `<schema/>`. The table below includes the default value for most `FieldType` implementations provided by Solr, assuming a `schema.xml` that declares `version="1.6"`.
+// TODO: SOLR-10655 BEGIN: refactor this into a 'field-default-properties.include.adoc' file for reuse
+
// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
[cols="20,40,20,20",options="header"]
@@ -103,6 +105,8 @@ The default values for each property depend on the underlying `FieldType` class,
|large |Large fields are always lazy loaded and will only take up space in the document cache if the actual value is < 512KB. This option requires `stored="true"` and `multiValued="false"`. It's intended for fields that might have very large values so that they don't get cached in memory. |true or false |false
|===
+// TODO: SOLR-10655 END
+
[[FieldTypeDefinitionsandProperties-FieldTypeSimilarity]]
== Field Type Similarity
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ccebeecd/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc b/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
index 9a458b1..9cfb196 100644
--- a/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
+++ b/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
@@ -16,6 +16,7 @@ The <<overview-of-the-solr-admin-ui.adoc#overview-of-the-solr-admin-ui,Overview
* *<<thread-dump.adoc#thread-dump,Thread Dump>>* lets you see detailed information about each thread, along with state information.
* *<<collection-specific-tools.adoc#collection-specific-tools,Collection-Specific Tools>>* is a section explaining additional screens available for each collection.
+// TODO: SOLR-10655 BEGIN: refactor this into a 'collection-screens-list.include.adoc' file for reuse
** <<analysis-screen.adoc#analysis-screen,Analysis>> - lets you analyze the data found in specific fields.
** <<dataimport-screen.adoc#dataimport-screen,Dataimport>> - shows you information about the current status of the Data Import Handler.
** <<documents-screen.adoc#documents-screen,Documents>> - provides a simple form allowing you to execute various Solr indexing commands directly from the browser.
@@ -23,8 +24,11 @@ The <<overview-of-the-solr-admin-ui.adoc#overview-of-the-solr-admin-ui,Overview
** <<query-screen.adoc#query-screen,Query>> - lets you submit a structured query about various elements of a core.
** <<stream-screen.adoc#stream-screen,Stream>> - allows you to submit streaming expressions and see results and parsing explanations.
** <<schema-browser-screen.adoc#schema-browser-screen,Schema Browser>> - displays schema data in a browser window.
+// TODO: SOLR-10655 END
* *<<core-specific-tools.adoc#core-specific-tools,Core-Specific Tools>>* is a section explaining additional screens available for each named core.
+// TODO: SOLR-10655 BEGIN: refactor this into a 'core-screens-list.include.adoc' file for reuse
** <<ping.adoc#ping,Ping>> - lets you ping a named core and determine whether the core is active.
** <<plugins-stats-screen#plugins-stats-screen,Plugins/Stats>> - shows statistics for plugins and other installed components.
** <<replication-screen.adoc#replication-screen,Replication>> - shows you the current replication status for the core, and lets you enable/disable replication.
** <<segments-info.adoc#segments-info,Segments Info>> - Provides a visualization of the underlying Lucene index segments.
+// TODO: SOLR-10655 END