Merge pull request #1135 from alanbernstein/docs-fixes

Docs fixes

docs/administration.md

@@ -124,7 +124,7 @@ Note: This will only work when the replication factor is >= 2
 - Restart the cluster
 - Wait for the 1st sync (10 minutes) to validate Index connections
 
-#### Diagnostics
+### Diagnostics
 
 Each Pilosa cluster is configured by default to share anonymous usage details with Pilosa Corp. These metrics allow us to understand how Pilosa is used by the community and improve the technology to suit your needs. Diagnostics are sent to Pilosa every hour. Each of the metrics are detailed below as well as opt-out instructions.
 
@@ -145,7 +145,7 @@ Each Pilosa cluster is configured by default to share anonymous usage details wi
  
 You can opt-out of the Pilosa diagnostics reporting by setting either the command line configuration option `--metric.diagnostics=false`, use the `PILOSA_METRIC_DIAGNOSTICS` environment variable, or the TOML configuration file `[metric]` `diagnostics` option.
 
-#### Metrics
+### Metrics
 
 Pilosa can be configured to emit metrics pertaining to its internal processes in one of two formats: Expvar or StatsD. Metric recording is disabled by default.
 The metrics configuration options are: 
@@ -154,7 +154,7 @@ The metrics configuration options are:
   - [Poll Interval](../configuration#metrics-poll-interval): specify polling interval for runtime metrics
   - [Service](../configuration#metrics-service): declare type StatsD or Expvar
 
-##### Tags
+#### Tags
 StatsD Tags adhere to the DataDog format (key:value), and we tag the following:
 
 - NodeID
@@ -163,7 +163,7 @@ StatsD Tags adhere to the DataDog format (key:value), and we tag the following:
 - View
 - Slice
 
-##### Events
+#### Events
 We currently track the following events
 
 - **Index:** The creation of a new Index.

docs/query-language.md

@@ -52,7 +52,7 @@ curl localhost:10101/index/repository/query \
 * `UINT` An unsigned integer (e.g. 42839)
 * `ATTR_NAME` Must be a valid identifier `[A-Za-z][A-Za-z0-9._-]*`
 * `ATTR_VALUE` Can be a string, float, integer, or bool.
-* `BITMAP_CALL` Any query which returns a bitmap, such as `Bitmap`, `Union`, `Difference`, `Intersect`, `Range`
+* `BITMAP_CALL` Any query which returns a bitmap, such as `Bitmap`, `Union`, `Difference`, `Xor`, `Intersect`, `Range`
 * `[]ATTR_VALUE` Denotes an array of `ATTR_VALUE`s. (e.g. `["a", "b", "c"]`)
 
 ### Write Operations
@@ -308,6 +308,34 @@ Return `{"attrs":{},"bits":[30]}`
 
 * Bits are repositories that were starred by user 2 BUT NOT user 1
 
+#### Xor
+
+**Spec:**
+
+```
+Xor(<BITMAP_CALL>, [BITMAP_CALL ...])
+```
+
+**Description:**
+
+Xor performs a logical XOR on the results of each `BITMAP_CALL` query passed to it.
+
+**Result Type:** object with attrs and bits
+
+attrs will always be empty
+
+**Examples:**
+
+Query repositories which have been starred by two users.
+
+```
+Xor(Bitmap(frame="stargazer", rowID=1), Bitmap(frame="stargazer", rowID=2))
+```
+
+Returns `{"attrs":{},"bits":[30]}`.
+
+* bits are repositories that were starred by user 1 XOR user 2 (user 1 or user 2, but not both)
+
 #### Count
 **Spec:**