Repository: incubator-impala Updated Branches: refs/heads/master 7e25ec8ec -> e24333c1f
IMPALA-4643: [DOCS] Elide Cloudera URLs for UDFs Hide a couple of assertions that someone should go or view things online, on Cloudera-specific github repos. Blank out some Cloudera-specific URLs for sample source files. This causes the relevant links to disappear - what was linked text is now just plain text. The user can still work off the excerpts in the docs, just not see the entire file. Once an authoritative Apache-friendly location is set up for UDF development, the URLs can be filled in and the relevant links will reappear in the doc output. Change-Id: Id5f325c88c5e9f1a7cd64d13ba7aa23249838181 Reviewed-on: http://gerrit.cloudera.org:8080/6464 Reviewed-by: Tim Armstrong <[email protected]> Reviewed-by: Jim Apple <[email protected]> Reviewed-by: John Russell <[email protected]> Tested-by: Impala Public Jenkins Project: http://git-wip-us.apache.org/repos/asf/incubator-impala/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-impala/commit/e24333c1 Tree: http://git-wip-us.apache.org/repos/asf/incubator-impala/tree/e24333c1 Diff: http://git-wip-us.apache.org/repos/asf/incubator-impala/diff/e24333c1 Branch: refs/heads/master Commit: e24333c1fb0c90d782bfeab6fd2b48cb6e225782 Parents: 7e25ec8 Author: John Russell <[email protected]> Authored: Thu Mar 23 11:15:42 2017 -0700 Committer: Impala Public Jenkins <[email protected]> Committed: Fri Mar 24 17:56:08 2017 +0000 ---------------------------------------------------------------------- docs/impala_keydefs.ditamap | 16 ++++++++-------- docs/topics/impala_udf.xml | 26 +++++++------------------- 2 files changed, 15 insertions(+), 27 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/e24333c1/docs/impala_keydefs.ditamap ---------------------------------------------------------------------- diff --git a/docs/impala_keydefs.ditamap b/docs/impala_keydefs.ditamap index 4f3ad3a..a00dc78 100644 --- a/docs/impala_keydefs.ditamap +++ b/docs/impala_keydefs.ditamap @@ -53,7 +53,7 @@ under the License. <topicmeta><linktext>the Security chapter in the Apache HBase documentation</linktext></topicmeta> </keydef> - <keydef href="https://github.com/cloudera/Impala/blob/cdh5-trunk/tests/query_test/test_udfs.py"; scope="external" format="html" keys="test_udfs.py"> + <keydef href="https://github.com/apache/incubator-impala/blob/master/tests/query_test/test_udfs.py"; scope="external" format="html" keys="test_udfs.py"> <topicmeta><linktext>test_udfs.py</linktext></topicmeta> </keydef> <keydef href="https://github.com/apache/incubator-impala/blob/master/be/src/exprs/timezone_db.cc"; scope="external" format="html" keys="timezone_db.cc"> @@ -62,22 +62,22 @@ under the License. <keydef href="https://github.com/cloudera/impala-tpcds-kit"; scope="external" format="html" keys="impala-tpcds-kit"> <topicmeta><linktext>impala-tpcds-kit</linktext></topicmeta> </keydef> - <keydef href="https://github.com/cloudera/impala-udf-samples"; scope="external" format="html" keys="udf-samples"> + <keydef href="" scope="external" format="html" keys="udf-samples"> <topicmeta><linktext>impala-udf-samples</linktext></topicmeta> </keydef> - <keydef href="https://github.com/cloudera/impala-udf-samples/blob/master/uda-sample.cc"; scope="external" format="html" keys="uda-sample.cc"> + <keydef href="" scope="external" format="html" keys="uda-sample.cc"> <topicmeta><linktext>uda-sample.cc</linktext></topicmeta> </keydef> - <keydef href="https://github.com/cloudera/impala-udf-samples/blob/master/udf-sample.h"; scope="external" format="html" keys="udf-sample.h"> + <keydef href="" scope="external" format="html" keys="udf-sample.h"> <topicmeta><linktext>udf-sample.h</linktext></topicmeta> </keydef> - <keydef href="https://github.com/cloudera/impala-udf-samples/blob/master/uda-sample.h"; scope="external" format="html" keys="uda-sample.h"> + <keydef href="" scope="external" format="html" keys="uda-sample.h"> <topicmeta><linktext>uda-sample.h</linktext></topicmeta> </keydef> - <keydef href="http://github.com/Cloudera/Impala/blob/cdh5-trunk/be/src/testutil/test-udas.cc"; scope="external" format="html" keys="test-udas.cc"> + <keydef href="https://github.com/apache/incubator-impala/blob/master/be/src/testutil/test-udas.cc"; scope="external" format="html" keys="test-udas.cc"> <topicmeta><linktext>test-udas.cc</linktext></topicmeta> </keydef> - <keydef href="https://github.com/cloudera/impala/tree/master/be/src/udf_samples"; scope="external" format="html" keys="udf_samples"> + <keydef href="" scope="external" format="html" keys="udf_samples"> <topicmeta><linktext>the udf_samples github repo</linktext></topicmeta> </keydef> @@ -95,7 +95,7 @@ under the License. <keydef href="https://issues.apache.org/jira/browse/IMPALA"; scope="external" format="html" keys="impala-jira"/> <keydef href="http://hadoop.apache.org/docs/current/hadoop-yarn/hadoop-yarn-site/FairScheduler.html#Configuration"; scope="external" format="html" keys="FairScheduler"/> - <keydef href="https://archive.cloudera.com/cdh5/"; scope="external" format="html" keys="archive_root"> + <keydef href="" scope="external" format="html" keys="archive_root"> <topicmeta><linktext>the top level of this software archive</linktext></topicmeta> </keydef> <keydef href="https://archive.cloudera.com/gplextras/redhat/5/x86_64/gplextras/"; scope="external" format="html" keys="gplextras"/> http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/e24333c1/docs/topics/impala_udf.xml ---------------------------------------------------------------------- diff --git a/docs/topics/impala_udf.xml b/docs/topics/impala_udf.xml index ad2ad07..10d98d1 100644 --- a/docs/topics/impala_udf.xml +++ b/docs/topics/impala_udf.xml @@ -381,7 +381,7 @@ Returned 1 row(s) in 0.11s +------------------+ Returned 1 row(s) in 0.11s</codeblock> - <p> + <p audience="hidden"> You can find the sample files mentioned here in <xref keyref="udf_samples"/>. </p> @@ -401,7 +401,6 @@ Returned 1 row(s) in 0.11s</codeblock> </conbody> </concept> - <concept id="udf_demo_env"> <title>Installing the UDF Development Package</title> @@ -415,7 +414,7 @@ Returned 1 row(s) in 0.11s</codeblock> </p> <ol> - <li> + <li audience="hidden"> Start at <xref keyref="archive_root"/>. </li> @@ -432,10 +431,8 @@ Returned 1 row(s) in 0.11s</codeblock> <note> - The UDF development code does not rely on Impala being installed on the same machine. You can write and compile UDFs on a minimal development system, then deploy them on a different one for use with Impala. - </note> <p> @@ -506,7 +503,6 @@ Returned 1 row(s) in 0.11s</codeblock> named <codeph>AddUdf()</codeph>: </p> -<!-- Downloadable version of this file: https://raw.githubusercontent.com/cloudera/impala-udf-samples/master/udf-sample.h --> <codeblock>#ifndef IMPALA_UDF_SAMPLE_UDF_H #define IMPALA_UDF_SAMPLE_UDF_H @@ -524,7 +520,6 @@ IntVal AddUdf(FunctionContext* context, const IntVal& arg1, const IntVal& <filepath>udf-sample.cc</filepath> within the sample build environment: </p> -<!-- Downloadable version of this file: https://raw.githubusercontent.com/cloudera/impala-udf-samples/master/udf-sample.cc --> <codeblock>#include "udf-sample.h" // In this sample we are declaring a UDF that adds two ints and returns an int. @@ -965,11 +960,9 @@ within UDAs, you can return without specifying a value. --> <p> - <filepath>uda-sample.h</filepath>: + <xref keyref="uda-sample.h"><filepath>uda-sample.h</filepath></xref>: </p> - <p> See this file online at: <xref keyref="uda-sample.h"/></p> - <codeblock audience="hidden">#ifndef SAMPLES_UDA_H #define SAMPLES_UDA_H @@ -1064,10 +1057,7 @@ StringVal ToStringVal(FunctionContext* context, const T& val); #endif</codeblock> <p> - <filepath>uda-sample.cc</filepath>: - </p> - - <p> See this file online at: <xref keyref="uda-sample.cc"/> + <xref keyref="uda-sample.cc"><filepath>uda-sample.cc</filepath></xref>: </p> <codeblock audience="hidden">#include "uda-sample.h" @@ -1264,10 +1254,8 @@ StringVal StringConcatFinalize(FunctionContext* context, const StringVal& va <p> For an example of this technique, see the <codeph>trunc_sum()</codeph> aggregate function, which accumulates intermediate results of type <codeph>DOUBLE</codeph> and returns <codeph>BIGINT</codeph> at the end. - View - <xref keyref="test_udfs.py">the <codeph>CREATE FUNCTION</codeph> statement</xref> - and - <xref keyref="test-udas.cc">the implementation of the underlying TruncSum*() functions</xref> + View <xref keyref="test_udfs.py">the <codeph>CREATE FUNCTION</codeph> statement</xref> + and <xref keyref="test-udas.cc">the implementation of the underlying TruncSum*() functions</xref> on Github. </p> </conbody> @@ -1442,7 +1430,7 @@ make</codeblock> This section demonstrates how to create and use all kinds of user-defined functions (UDFs). </p> - <p> + <p audience="hidden"> For downloadable examples that you can experiment with, adapt, and use as templates for your own functions, see <xref keyref="udf-samples" scope="external" format="html">the Impala sample UDF github</xref>. You must have already installed the appropriate header files, as explained in
