You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2015/11/03 07:09:47 UTC
[11/51] trafficserver git commit: Documentation reorganization
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlCreate.en.rst b/doc/reference/api/TSUrlCreate.en.rst
deleted file mode 100644
index ad15af0..0000000
--- a/doc/reference/api/TSUrlCreate.en.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. default-domain:: c
-
-===========
-TSUrlCreate
-===========
-
-Traffic Server URL object construction API.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: TSReturnCode TSUrlCreate(TSMBuffer bufp, TSMLoc* locp)
-.. function:: TSReturnCode TSUrlClone(TSMBuffer dest_bufp, TSMBuffer src_bufp, TSMLoc src_url, TSMLoc* locp)
-.. function:: TSReturnCode TSUrlCopy(TSMBuffer dest_bufp, TSMLoc dest_url, TSMBuffer src_bufp, TSMLoc src_url)
-.. function:: TSParseResult TSUrlParse(TSMBuffer bufp, TSMLoc offset, const char ** start, const char* end)
-
-Description
-===========
-
-The URL data structure is a parsed version of a standard internet URL. The
-Traffic Server URL API provides access to URL data stored in marshal
-buffers. The URL functions can create, copy, retrieve or delete entire URLs,
-and retrieve or modify parts of URLs, such as their host, port or scheme
-information.
-
-:func:`TSUrlCreate` creates a new URL within the marshal buffer
-:data:`bufp`. Release the resulting handle with a call to
-:func:`TSHandleMLocRelease`.
-
-:func:`TSUrlClone` copies the contents of the URL at location :data:`src_url`
-within the marshal buffer :data:`src_bufp` to a location within the marshal
-buffer :data:`dest_bufp`. Release the returned handle with a call to
-:func:`TSHandleMLocRelease`.
-
-:func:`TSUrlCopy` copies the contents of the URL at location :data:`src_url`
-within the marshal buffer :data:`src_bufp` to the location :data:`dest_url`
-within the marshal buffer dest_bufp. :func:`TSUrlCopy` works correctly even if
-:data:`src_bufp` and :data:`dest_bufp` point to different marshal buffers. It
-is important for the destination URL (its marshal buffer and :type:`TSMLoc`)
-to have been created before copying into it.
-
-:func:`TSUrlParse` parses a URL. The :data:`start` pointer is both an input
-and an output parameter and marks the start of the URL to be parsed. After a
-successful parse, the :data:`start` pointer equals the :data:`end`
-pointer. The :data:`end` pointer must be one byte after the last character you
-want to parse. The URL parsing routine assumes that everything between
-:data:`start` and :data:`end` is part of the URL. It is up to higher level
-parsing routines, such as :func:`TSHttpHdrParseReq`, to determine the actual
-end of the URL.
-
-Return values
-=============
-
-The :func:`TSUrlParse` function returns a :type:`TSParseResult`, where
-:data:`TS_PARSE_ERROR` indicates an error. Success is indicated by one of
-:data:`TS_PARSE_DONE`, :data:`TS_PARSE_OK` or :data:`TS_PARSE_CONT`. The other
-APIs all return a :type:`TSReturnCode`, indicating success
-(:data:`TS_SUCCESS`) or failure (:data:`TS_ERROR`) of the operation.
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`,
-:manpage:`TSMBufferCreate(3ts)`,
-:manpage:`TSUrlHostGet(3ts)`,
-:manpage:`TSUrlHostSet(3ts)`,
-:manpage:`TSUrlStringGet(3ts)`,
-:manpage:`TSUrlPercentEncode(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlDestroy.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlDestroy.en.rst b/doc/reference/api/TSUrlDestroy.en.rst
deleted file mode 100644
index 68cebbc..0000000
--- a/doc/reference/api/TSUrlDestroy.en.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSUrlDestroy
-============
-
-Destroys the URL located at url_loc within the marshal buffer bufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSUrlDestroy(TSMBuffer bufp, TSMLoc offset)
-
-
-Description
------------
-
-Do not forget to release the :c:type:`TSMLoc` url_loc with a call to
-:c:func:`TSHandleMLocRelease`.
-
-.. admonition:: Deprecated
-
- There is no reason to destroy the URL, just release the marshal
- buffers.
-
-Should be removed for v5.0.0
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlFtpTypeGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlFtpTypeGet.en.rst b/doc/reference/api/TSUrlFtpTypeGet.en.rst
deleted file mode 100644
index f95355a..0000000
--- a/doc/reference/api/TSUrlFtpTypeGet.en.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSUrlFtpTypeGet
-===============
-
-Retrieves the FTP type of the URL located at url_loc within bufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int TSUrlFtpTypeGet(TSMBuffer bufp, TSMLoc offset)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlFtpTypeSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlFtpTypeSet.en.rst b/doc/reference/api/TSUrlFtpTypeSet.en.rst
deleted file mode 100644
index 8880bf7..0000000
--- a/doc/reference/api/TSUrlFtpTypeSet.en.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSUrlFtpTypeSet
-===============
-
-Sets the FTP type portion of the URL located at url_loc within bufp to
-the value type.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSUrlFtpTypeSet(TSMBuffer bufp, TSMLoc offset, int type)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlHostGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlHostGet.en.rst b/doc/reference/api/TSUrlHostGet.en.rst
deleted file mode 100644
index fbaa7bf..0000000
--- a/doc/reference/api/TSUrlHostGet.en.rst
+++ /dev/null
@@ -1,81 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. default-domain:: c
-
-============
-TSUrlHostGet
-============
-
-Traffic Server URL component retrieval API.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: const char* TSUrlHostGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: const char* TSUrlSchemeGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: const char* TSUrlUserGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: const char* TSUrlPasswordGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: int TSUrlPortGet(TSMBuffer bufp, TSMLoc offset)
-.. function:: const char* TSUrlPathGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: const char* TSUrlHttpQueryGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: const char* TSUrlHttpParamsGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: const char* TSUrlHttpFragmentGet(TSMBuffer bufp, TSMLoc offset, int* length)
-
-Description
-===========
-
-The URL data structure is a parsed version of a standard internet URL. The
-Traffic Server URL API provides access to URL data stored in marshal
-buffers. The URL functions can create, copy, retrieve or delete entire URLs,
-and retrieve or modify parts of URLs, such as their host, port or scheme
-information.
-
-:func:`TSUrlSchemeGet`, :func:`TSUrlUserGet`, :func:`TSUrlPasswordGet`,
-:func:`TSUrlHostGet`, :func:`TSUrlHttpParamsGet`, :func:`TSUrlHttpQueryGet`
-and :func:`TSUrlHttpFragmentGet` each retrieve an internal pointer to the
-specified portion of the URL from the marshall buffer :data:`bufp`. The length
-of the returned string is placed in :data:`length` and a pointer to the URL
-portion is returned.
-
-:func:`TSUrlPortGet` retrieves the port number portion of the URL located at
-:data:`offset` within the marshal buffer :data:`bufp`. If there is no explicit
-port number in the URL, a canonicalized valued is returned based on the URL
-scheme.
-
-Return values
-=============
-
-All APIs except :func:`TSUrlPortGet` returns a string, which is not guaranteed
-to be NULL terminated. You must therefore always use the :data:`length` value
-to determine the actual length of the returned string.
-
-:func:`TSUrlPortGet` simply returns the port number as an integer, possibly
-canonicalized with :data:`80` for HTTP and :data:`443` for HTTPS schemes. If
-there is neither port nor scheme information available in the URL, :data:`0`
-is returned.
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`,
-:manpage:`TSUrlCreate(3ts)`,
-:manpage:`TSUrlHostSet(3ts)`,
-:manpage:`TSUrlStringGet(3ts)`,
-:manpage:`TSUrlPercentEncode(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlHostSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlHostSet.en.rst b/doc/reference/api/TSUrlHostSet.en.rst
deleted file mode 100644
index 7c7c8dc..0000000
--- a/doc/reference/api/TSUrlHostSet.en.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. default-domain:: c
-
-============
-TSUrlHostSet
-============
-
-Traffic Server URL component manipulation API.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: TSReturnCode TSUrlHostSet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-.. function:: TSReturnCode TSUrlSchemeSet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-.. function:: TSReturnCode TSUrlUserSet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-.. function:: TSReturnCode TSUrlPasswordSet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-.. function:: TSReturnCode TSUrlPortSet(TSMBuffer bufp, TSMLoc offset, int port)
-.. function:: TSReturnCode TSUrlPathSet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-.. function:: TSReturnCode TSUrlHttpQuerySet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-.. function:: TSReturnCode TSUrlHttpParamsSet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-.. function:: TSReturnCode TSUrlHttpFragmentSet(TSMBuffer bufp, TSMLoc offset, const char* value, int length)
-
-Description
-===========
-
-The URL data structure is a parsed version of a standard internet URL. The
-Traffic Server URL API provides access to URL data stored in marshal
-buffers. The URL functions can create, copy, retrieve or delete entire URLs,
-and retrieve or modify parts of URLs, such as their host, port or scheme
-information.
-
-:func:`TSUrlSchemeSet`, :func:`TSUrlUserSet`, :func:`TSUrlPasswordSet`,
-:func:`TSUrlHostSet`, :func:`TSUrlHttpParamsSet`, :func:`TSUrlHttpQuerySet`
-and :func:`TSUrlHttpFragmentSet` each set the specified portion of the URL
-located at offset within the marshal buffer :arg:`bufp` to the string
-value. If :arg:`length` is ``-1`` then these functions assume that value
-is NULL-terminated. Otherwise, the length of the :arg:`string` value is taken
-to be the value of :arg:`length`. These functions copy the string to within
-:arg:`bufp`, so it can be subsequently modified or deleted.
-
-:func:`TSUrlPortSet` sets the port number portion of the URL located at
-:arg:`offset` within the marshal buffer :arg:`bufp` to the value
-port. Normal canonicalization based on the URL scheme still applies.
-
-Return values
-=============
-
-All these APIs returns a :type:`TSReturnCode`, indicating success
-(:data:`TS_SUCCESS`) or failure (:data:`TS_ERROR`) of the operation.
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`,
-:manpage:`TSUrlCreate(3ts)`,
-:manpage:`TSUrlHostGet(3ts)`,
-:manpage:`TSUrlStringGet(3ts)`,
-:manpage:`TSUrlPercentEncode(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlPercentEncode.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlPercentEncode.en.rst b/doc/reference/api/TSUrlPercentEncode.en.rst
deleted file mode 100644
index 5a75930..0000000
--- a/doc/reference/api/TSUrlPercentEncode.en.rst
+++ /dev/null
@@ -1,69 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. default-domain:: c
-
-==================
-TSUrlPercentEncode
-==================
-
-Traffic Server URL percent encoding API.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: TSReturnCode TSUrlPercentEncode(TSMBuffer bufp, TSMLoc offset, char* dst, size_t dst_size, size_t* length, const unsigned char* map)
-.. function:: TSReturnCode TSStringPercentEncode(const char* str, int str_len, char* dst, size_t dst_size, size_t* length, const unsigned char* map)
-.. function:: TSReturnCode TSStringPercentDecode(const char* str, size_t str_len, char* dst, size_t dst_size, size_t* length)
-
-Description
-===========
-
-The URL data structure is a parsed version of a standard internet URL. The
-Traffic Server URL API provides access to URL data stored in marshal
-buffers. The URL functions can create, copy, retrieve or delete entire URLs,
-and retrieve or modify parts of URLs, such as their host, port or scheme
-information.
-
-:func:`TSUrlPercentEncode` performs percent-encoding of the URL object,
-storing the new string in the :data:`dst` buffer. The :data:`length` parameter
-will be set to the new (encoded) string length, or :data:`0` if the encoding
-failed. :func:`TSStringPercentEncode` is similar but operates on a string. If
-the optional :data:`map` parameter is provided (not :data:`NULL`) , it should
-be a map of characters to encode.
-
-:func:`TSStringPercentDecode` perform percent-decoding of the string in the
-:data:`str` buffer, writing to the :data:`dst` buffer. The source and
-destination can be the same, in which case they overwrite. The decoded string
-is always guaranteed to be no longer than the source string.
-
-Return values
-=============
-
-All these APIs returns a :type:`TSReturnCode`, indicating success
-(:data:`TS_SUCCESS`) or failure (:data:`TS_ERROR`) of the operation.
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`,
-:manpage:`TSUrlCreate(3ts)`,
-:manpage:`TSUrlHostGet(3ts)`,
-:manpage:`TSUrlHostSet(3ts)`,
-:manpage:`TSUrlStringGet(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSUrlStringGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlStringGet.en.rst b/doc/reference/api/TSUrlStringGet.en.rst
deleted file mode 100644
index 8c15bac..0000000
--- a/doc/reference/api/TSUrlStringGet.en.rst
+++ /dev/null
@@ -1,69 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. default-domain:: c
-
-==============
-TSUrlStringGet
-==============
-
-Traffic Server URL string representations API.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: char* TSUrlStringGet(TSMBuffer bufp, TSMLoc offset, int* length)
-.. function:: int TSUrlLengthGet(TSMBuffer bufp, TSMLoc offset)
-.. function:: void TSUrlPrint(TSMBuffer bufp, TSMLoc offset, TSIOBuffer iobufp)
-
-
-Description
-===========
-
-The URL data structure is a parsed version of a standard internet URL. The
-Traffic Server URL API provides access to URL data stored in marshal
-buffers. The URL functions can create, copy, retrieve or delete entire URLs,
-and retrieve or modify parts of URLs, such as their host, port or scheme
-information.
-
-:func:`TSUrlStringGet` constructs a string representation of the URL located
-at :data:`offset` within the marshal buffer :data:`bufp`.
-:func:`TSUrlStringGet` stores the length of the allocated string in the
-parameter :data:`length`. This is the same length that :func:`TSUrlLengthGet`
-returns. The returned string is allocated by a call to :func:`TSmalloc` and
-must be freed by a call to :func:`TSfree`. If length is :data:`NULL` then no
-attempt is made to de-reference it.
-
-:func:`TSUrlLengthGet` calculates the length of the URL located at
-:data:`offset` within the marshal buffer bufp as if it were returned as a
-string. This length will be the same as the length returned by
-:func:`TSUrlStringGet`.
-
-:func:`TSUrlPrint` formats a URL stored in an :type:`TSMBuffer` to an
-:type:`TSIOBuffer`.
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`,
-:manpage:`TSmalloc(3ts)`,
-:manpage:`TSUrlCreate(3ts)`,
-:manpage:`TSUrlHostGet(3ts)`,
-:manpage:`TSUrlHostSet(3ts)`,
-:manpage:`TSUrlPercentEncode(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnAbort.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnAbort.en.rst b/doc/reference/api/TSVConnAbort.en.rst
deleted file mode 100644
index 8eebdbf..0000000
--- a/doc/reference/api/TSVConnAbort.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnAbort
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSVConnAbort(TSVConn connp, int error)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnCacheObjectSizeGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnCacheObjectSizeGet.en.rst b/doc/reference/api/TSVConnCacheObjectSizeGet.en.rst
deleted file mode 100644
index 8c29974..0000000
--- a/doc/reference/api/TSVConnCacheObjectSizeGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnCacheObjectSizeGet
-=========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int64_t TSVConnCacheObjectSizeGet(TSVConn connp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnClose.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnClose.en.rst b/doc/reference/api/TSVConnClose.en.rst
deleted file mode 100644
index 8b2baaa..0000000
--- a/doc/reference/api/TSVConnClose.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnClose
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSVConnClose(TSVConn connp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnClosedGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnClosedGet.en.rst b/doc/reference/api/TSVConnClosedGet.en.rst
deleted file mode 100644
index 0c14479..0000000
--- a/doc/reference/api/TSVConnClosedGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnClosedGet
-================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int TSVConnClosedGet(TSVConn connp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnFdCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnFdCreate.en.rst b/doc/reference/api/TSVConnFdCreate.en.rst
deleted file mode 100644
index dde0961..0000000
--- a/doc/reference/api/TSVConnFdCreate.en.rst
+++ /dev/null
@@ -1,63 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-.. default-domain:: c
-
-TSVConnFdCreate
-===============
-
-Create a TSVConn from a socket.
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVConn TSVConnFdCreate(int fd)
-
-Description
------------
-
-:func:`TSVConnFdCreate` accepts a network socket and returns a new
-:type:`TSVConn` constructed from the socket. The socket descriptor
-must be an already connected socket. It will be placed into
-non-blocking mode.
-
-Return Values
--------------
-
-On success, the returned TSVConn object owns the socket and the
-caller must not close it. If :func:`TSVConnFdCreate` fails, :data:`NULL`
-is returned, the socket is unchanged and the caller must close
-it.
-
-Examples
---------
-
-The example below is excerpted from `example/intercept/intercept.cc`
-in the Traffic Server source distribution. It demonstrates how to
-use :func:`TSVConnFdCreate` to construct a :type:`TSVConn` from a
-connected socket.
-
-.. literalinclude:: ../../../example/intercept/intercept.cc
- :language: c
- :lines: 288-336
-
-See also
---------
-
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnIsSsl.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnIsSsl.en.rst b/doc/reference/api/TSVConnIsSsl.en.rst
deleted file mode 100644
index c04c699..0000000
--- a/doc/reference/api/TSVConnIsSsl.en.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnIsSsl
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int TSVConnIsSsl(TSVConn svc)
-
-Description
------------
-
- Determines whether the connection associated with :arg:`svc` is being processed as an SSL connection. Returns 1 if it is being processed as SSL and 0 otherwise.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnRead.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnRead.en.rst b/doc/reference/api/TSVConnRead.en.rst
deleted file mode 100644
index 369d004..0000000
--- a/doc/reference/api/TSVConnRead.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnRead
-===========
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVIO TSVConnRead(TSVConn connp, TSCont contp, TSIOBuffer bufp, int64_t nbytes)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnReadVIOGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnReadVIOGet.en.rst b/doc/reference/api/TSVConnReadVIOGet.en.rst
deleted file mode 100644
index ec2e7d2..0000000
--- a/doc/reference/api/TSVConnReadVIOGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnReadVIOGet
-=================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVIO TSVConnReadVIOGet(TSVConn connp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnReenable.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnReenable.en.rst b/doc/reference/api/TSVConnReenable.en.rst
deleted file mode 100644
index 4e6f393..0000000
--- a/doc/reference/api/TSVConnReenable.en.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnReenable
-===============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSSslVConnReenable(TSVConn svc)
-
-Description
------------
-
-Reenable the SSL connection :arg:`svc`. If a plugin hook is called, ATS processing on that connnection will not resume until this is invoked for that connection.
-
-If the server is running openssl 1.0.1 with the appropraite patch installed or it is running openssl 1.0.2, the plugin writer can pause SSL handshake processing by not reenabling the connection. Without the openSSL patch or running an openssl version older than 1.0.2, the handshake processing in ``SSL_accept`` will not be stopped even if the SNI callback does not reenable the connection.
-
-Additional processing could reenable the virtual connection causing the ``SSL_accept`` to be called again to complete the handshake exchange. In the case of a blind tunnel conversion, the SSL handshake will never be completed by Traffic Server.
-
-This call does appropriate locking and scheduling, so it is safe to call from another thread.
-
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnShutdown.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnShutdown.en.rst b/doc/reference/api/TSVConnShutdown.en.rst
deleted file mode 100644
index c53b210..0000000
--- a/doc/reference/api/TSVConnShutdown.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnShutdown
-===============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSVConnShutdown(TSVConn connp, int read, int write)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnSslConnectionGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnSslConnectionGet.en.rst b/doc/reference/api/TSVConnSslConnectionGet.en.rst
deleted file mode 100644
index eeb69ae..0000000
--- a/doc/reference/api/TSVConnSslConnectionGet.en.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnSslConnectionGet
-=======================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSSslVConnection TSVConnSslConnectionGet(TSVConn svc)
-
-
-Description
------------
-
- Get the SSL (per connection) object from the SSl connection :arg:`svc`.
-
-
-Types
------
-
-.. c:type:: TSSslVConnection
-
- The SSL (per connection) object. This is an opaque type that can be cast to the appropriate type (SSL * for the openSSL library).
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnTunnel.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnTunnel.en.rst b/doc/reference/api/TSVConnTunnel.en.rst
deleted file mode 100644
index a479df9..0000000
--- a/doc/reference/api/TSVConnTunnel.en.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnTunnel
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSVConnTunnel(TSVConn svc)
-
-
-Description
------------
-
-Set the SSL connection :arg:`svc` to convert to a blind tunnel. Can be called from the TS_VCONN_PRE_ACCEPT_HOOK or the TS_SSL_SNI_HOOK/TS_SSL_CERT_HOOK.
-
-For this to work from the TS_SSL_SNI_HOOK/TS_SSL_CERT_HOOK, either the server must be running openssl 1.0.2 or a version of openssl 1.0.1 with the appropriate patch installed.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnWrite.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnWrite.en.rst b/doc/reference/api/TSVConnWrite.en.rst
deleted file mode 100644
index 0080577..0000000
--- a/doc/reference/api/TSVConnWrite.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnWrite
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVIO TSVConnWrite(TSVConn connp, TSCont contp, TSIOBufferReader readerp, int64_t nbytes)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVConnWriteVIOGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnWriteVIOGet.en.rst b/doc/reference/api/TSVConnWriteVIOGet.en.rst
deleted file mode 100644
index 3963a28..0000000
--- a/doc/reference/api/TSVConnWriteVIOGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVConnWriteVIOGet
-==================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVIO TSVConnWriteVIOGet(TSVConn connp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIOBufferGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOBufferGet.en.rst b/doc/reference/api/TSVIOBufferGet.en.rst
deleted file mode 100644
index 529b658..0000000
--- a/doc/reference/api/TSVIOBufferGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIOBufferGet
-==============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSIOBuffer TSVIOBufferGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIOContGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOContGet.en.rst b/doc/reference/api/TSVIOContGet.en.rst
deleted file mode 100644
index fe2afd7..0000000
--- a/doc/reference/api/TSVIOContGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIOContGet
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSCont TSVIOContGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIOMutexGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOMutexGet.en.rst b/doc/reference/api/TSVIOMutexGet.en.rst
deleted file mode 100644
index 1dc30be..0000000
--- a/doc/reference/api/TSVIOMutexGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIOMutexGet
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSMutex TSVIOMutexGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIONBytesGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONBytesGet.en.rst b/doc/reference/api/TSVIONBytesGet.en.rst
deleted file mode 100644
index fcddfb6..0000000
--- a/doc/reference/api/TSVIONBytesGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIONBytesGet
-==============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int64_t TSVIONBytesGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIONBytesSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONBytesSet.en.rst b/doc/reference/api/TSVIONBytesSet.en.rst
deleted file mode 100644
index f04a2ba..0000000
--- a/doc/reference/api/TSVIONBytesSet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIONBytesSet
-==============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSVIONBytesSet(TSVIO viop, int64_t nbytes)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIONDoneGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONDoneGet.en.rst b/doc/reference/api/TSVIONDoneGet.en.rst
deleted file mode 100644
index 6eec3ea..0000000
--- a/doc/reference/api/TSVIONDoneGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIONDoneGet
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int64_t TSVIONDoneGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIONDoneSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONDoneSet.en.rst b/doc/reference/api/TSVIONDoneSet.en.rst
deleted file mode 100644
index a4e7365..0000000
--- a/doc/reference/api/TSVIONDoneSet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIONDoneSet
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSVIONDoneSet(TSVIO viop, int64_t ndone)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIONTodoGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONTodoGet.en.rst b/doc/reference/api/TSVIONTodoGet.en.rst
deleted file mode 100644
index 14fe707..0000000
--- a/doc/reference/api/TSVIONTodoGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIONTodoGet
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int64_t TSVIONTodoGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIOReaderGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOReaderGet.en.rst b/doc/reference/api/TSVIOReaderGet.en.rst
deleted file mode 100644
index 3b630a4..0000000
--- a/doc/reference/api/TSVIOReaderGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIOReaderGet
-==============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSIOBufferReader TSVIOReaderGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIOReenable.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOReenable.en.rst b/doc/reference/api/TSVIOReenable.en.rst
deleted file mode 100644
index 79e8d7b..0000000
--- a/doc/reference/api/TSVIOReenable.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIOReenable
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSVIOReenable(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSVIOVConnGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOVConnGet.en.rst b/doc/reference/api/TSVIOVConnGet.en.rst
deleted file mode 100644
index 441ab95..0000000
--- a/doc/reference/api/TSVIOVConnGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSVIOVConnGet
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVConn TSVIOVConnGet(TSVIO viop)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSfclose.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfclose.en.rst b/doc/reference/api/TSfclose.en.rst
deleted file mode 100644
index 4aafd8f..0000000
--- a/doc/reference/api/TSfclose.en.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSfclose
-========
-
-Closes the file to which filep points and frees the data structures
-and buffers associated with it.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSfclose(TSFile filep)
-
-
-Description
------------
-
-If the file was opened for writing, any pending data is flushed.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSfflush.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfflush.en.rst b/doc/reference/api/TSfflush.en.rst
deleted file mode 100644
index db83b10..0000000
--- a/doc/reference/api/TSfflush.en.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSfflush
-========
-
-Flushes pending data that has been buffered up in memory from previous
-calls to :c:func:`TSfwrite`.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSfflush(TSFile filep)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSfgets.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfgets.en.rst b/doc/reference/api/TSfgets.en.rst
deleted file mode 100644
index 6dbbd95..0000000
--- a/doc/reference/api/TSfgets.en.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSfgets
-=======
-
-Reads a line from the file pointed to by filep into the buffer buf.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: char* TSfgets(TSFile filep, char *buf, size_t length)
-
-
-Description
------------
-
-Lines are terminated by a line feed character, ' '. The line placed
-in the buffer includes the line feed character and is terminated with
-a NULL. If the line is longer than length bytes then only the first
-length-minus-1 bytes are placed in buf.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSfopen.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfopen.en.rst b/doc/reference/api/TSfopen.en.rst
deleted file mode 100644
index 76f6f96..0000000
--- a/doc/reference/api/TSfopen.en.rst
+++ /dev/null
@@ -1,37 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSfopen
-=======
-
-Opens a file for reading or writing and returns a descriptor for
-accessing the file.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSFile TSfopen(const char *filename, const char *mode)
-
-
-Description
------------
-
-The current implementation cannot open a file for both reading or
-writing. See the SDK Programmer's Guide for sample code.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSfread.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfread.en.rst b/doc/reference/api/TSfread.en.rst
deleted file mode 100644
index ba40c16..0000000
--- a/doc/reference/api/TSfread.en.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSfread
-=======
-
-Attempts to read length bytes of data from the file pointed to by
-filep into the buffer buf.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: size_t TSfread(TSFile filep, void *buf, size_t length)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSfwrite.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfwrite.en.rst b/doc/reference/api/TSfwrite.en.rst
deleted file mode 100644
index 64d3e1e..0000000
--- a/doc/reference/api/TSfwrite.en.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-
-TSfwrite
-========
-
-Attempts to write length bytes of data from the buffer buf to the file
-filep.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: size_t TSfwrite(TSFile filep, const void *buf, size_t length)
-
-
-Description
------------
-
-Make sure that filep is open for writing. You might want to check the
-number of bytes written (:c:func:`TSfwrite` returns this value)
-against the value of length. If it is less, there might be
-insufficient space on disk, for example.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSmalloc.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSmalloc.en.rst b/doc/reference/api/TSmalloc.en.rst
deleted file mode 100644
index 19da27f..0000000
--- a/doc/reference/api/TSmalloc.en.rst
+++ /dev/null
@@ -1,81 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. default-domain:: c
-
-========
-TSmalloc
-========
-
-Traffic Server memory allocation API.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: void * TSmalloc(size_t size , const char * path)
-.. function:: void * TSrealloc(void * ptr , size_t size , const char * path)
-.. function:: char * TSstrdup(const char * str)
-.. function:: char * TSstrndup(const char * str, size_t size)
-.. function:: size_t TSstrlcpy(char * dst , const char * src , size_t size)
-.. function:: size_t TSstrlcat(char * dst , const char * src , size_t size)
-.. function:: void TSfree(void * ptr)
-
-Description
-===========
-
-Traffic Server provides a number of routines for allocating and freeing
-memory. These routines correspond to similar routines in the C library.
-For example, :func:`TSrealloc` behaves like the C library routine :func:`realloc`.
-There are two reasons to use the routines provided by Traffic Server. The
-first is portability. The Traffic Server API routines behave the same on
-all of Traffic Servers supported platforms. For example, :func:`realloc` does
-not accept an argument of :data:`NULL` on some platforms. The second reason is
-that the Traffic Server routines actually track the memory allocations by
-file and line number. This tracking is very efficient, is always turned
-on, and is useful for tracking down memory leaks.
-
-:func:`TSmalloc` returns a pointer to size bytes of memory allocated from the
-heap. Traffic Server uses :func:`TSmalloc` internally for memory allocations.
-Always use :func:`TSfree` to release memory allocated by :func:`TSmalloc`; do not use
-:func:`free`.
-
-:func:`TSstrdup` returns a pointer to a new string that is a duplicate
-of the string pointed to by str. The memory for the new string is
-allocated using :func:`TSmalloc` and should be freed by a call to
-:func:`TSfree`. :func:`TSstrndup` returns a pointer to a new string that
-is a duplicate of the string pointed to by str and size bytes
-long. The new string will be NUL-terminated. This API is very
-useful for transforming non NUL-terminated string values returned
-by APIs such as :func:`TSMimeHdrFieldValueStringGet` into NUL-terminated
-string values. The memory for the new string is allocated using
-:func:`TSmalloc` and should be freed by a call to :func:`TSfree`.
-
-:func:`TSstrlcpy` copies up to size - 1 characters from the NUL-terminated
-string src to dst, NUL-terminating the result.
-
-:func:`TSstrlcat` appends the NUL-terminated string src to the end of dst. It
-will append at most size - strlen(dst) - 1 bytes, NUL-terminating the
-result.
-
-:func:`TSfree` releases the memory allocated by :func:`TSmalloc` or :func:`TSrealloc`. If
-ptr is :data:`NULL`, :func:`TSfree` does no operation.
-
-See also
-========
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/index.en.rst b/doc/reference/api/index.en.rst
deleted file mode 100644
index 1725164..0000000
--- a/doc/reference/api/index.en.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-API Reference
-*************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. toctree::
- :glob:
- :maxdepth: 1
-
- *
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/index.en.rst b/doc/reference/commands/index.en.rst
deleted file mode 100644
index ed49d9d..0000000
--- a/doc/reference/commands/index.en.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-Command Reference
-=================
-
-.. toctree::
- :maxdepth: 1
-
- traffic_cop.en
- traffic_crashlog.en
- traffic_ctl.en
- traffic_line.en
- traffic_logcat.en
- traffic_logstats.en
- traffic_manager.en
- traffic_server.en
- traffic_top.en
- traffic_via.en
- traffic_wccp.en
- tspush.en
- tsxs.en
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_cop.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_cop.en.rst b/doc/reference/commands/traffic_cop.en.rst
deleted file mode 100644
index 23808c3..0000000
--- a/doc/reference/commands/traffic_cop.en.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. _traffic_cop:
-
-===========
-traffic_cop
-===========
-
-.. program:: traffic_cop
-
-Description
-===========
-
-:program:`traffic_cop` is a watchdog program that is responsible
-for starting :program:`traffic_manager` and :program:`traffic_server`
-and monitoring them for responsiveness. If either of these processes
-are determined to be unresponsive, :program:`traffic_cop` will kill
-and restart them.
-
-On Linux, :program:`traffic_cop` will also monitor available memory
-and swap space, restarting the watched processes if the available
-memory falls below a minimum threshold. The memory thresholds can
-be configured with the :ts:cv:`proxy.config.cop.linux_min_swapfree_kb`
-and :ts:cv:`proxy.config.cop.linux_min_memfree_kb` variables.
-
-The following options are available:
-
-.. option:: -d, --debug
-
- Emit debugging messages.
-
-.. option:: -o, --stdout
-
- :program:`traffic_cop` ordinarily logs to syslog, however for
- debugging purposes, this option causes it to print messages to
- standard output instead.
-
-.. option:: -s, --stop
-
- Kill children using ``SIGSTOP`` instead of ``SIGKILL``. This
- option is primarily for debugging.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
-See also
-========
-
-:manpage:`syslog(1)`,
-:manpage:`traffic_manager(8)`,
-:manpage:`traffic_server(8)`
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_crashlog.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_crashlog.en.rst b/doc/reference/commands/traffic_crashlog.en.rst
deleted file mode 100644
index f2f3a90..0000000
--- a/doc/reference/commands/traffic_crashlog.en.rst
+++ /dev/null
@@ -1,94 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-================
-traffic_crashlog
-================
-
-Synopsis
-========
-
-
-:program:`traffic_crashlog` [options]
-
-.. _traffic-crashlog-commands:
-
-Description
-===========
-
-:program:`traffic_crashlog` is a helper process that catches Traffic Server
-crashes and writes a crash report log to the logging directory. Other than for
-debugging or development purposes, :program:`traffic_crashlog` is not intended
-for users to run directly.
-
-When :program:`traffic_server` starts, it will launch a
-:program:`traffic_crashlog` process and keep it stopped, activating
-it only if a crash occurs.
-
-Options
-=======
-
-.. program:: traffic_crashlog
-
-.. option:: --host TRIPLE
-
- This option specifies the host triple for the process that
- :program:`traffic_crashlog` should examine. If a supported host
- triple is specified, :program:`traffic_crashlog` expects to
- receive a ``siginfo_t`` structure on it's standard input,
- followed by a ``ucontext_t``.
-
-.. option:: --target PID
-
- Specifies the process ID of the crashing :program:`traffic_server`
- process. If this option is not specified, :program:`traffic_crashlog`
- assumes it should examine it's parent process.
-
-.. option:: --syslog
-
- This option causes :program:`traffic_crashlog` to log the name
- of the crash log it creates to the system log.
-
-.. option:: --debug
-
- This option enables debugging mode. In this mode,
- :program:`traffic_crashlog` emits the log to it's standard
- output.
-
-.. option:: --wait
-
- This option causes :program:`traffic_crashlog` to stop itself
- immediately after it is launched. :program:`traffic_server`
- will allow it to continue only when a crash occurs.
-
-Caveats
-=======
-
-:program:`traffic_crashlog` makes use of various Traffic Server management
-APIs. If :program:`traffic_manager` is not available, the crash log will be
-incomplete.
-
-:program:`traffic_crashlog` may generate a crash log containing information you
-would rather not share outside your organization. Please examine the crash log
-carefully before posting it in a public forum.
-
-See also
-========
-
-:manpage:`records.config(5)`,
-:manpage:`traffic_manager(8)`,
-:manpage:`traffic_server(8)`