From c2734d336f0a04c10d08f2bbfe89fd9cd298f638 Mon Sep 17 00:00:00 2001 From: "vikram.choudhary" Date: Wed, 7 Oct 2015 18:29:04 +0530 Subject: [PATCH] Adding headers to the devref docs This patch adds missing headers to all the devref documents. Change-Id: Ice2f93f37a2cade7d5af552aaae6cd9f66dc953c --- doc/source/devref/advanced_services.rst | 23 ++++++++++++++++++++++ doc/source/devref/api_extensions.rst | 24 ++++++++++++++++++++++- doc/source/devref/api_layer.rst | 23 ++++++++++++++++++++++ doc/source/devref/callbacks.rst | 24 ++++++++++++++++++++++- doc/source/devref/db_layer.rst | 23 ++++++++++++++++++++++ doc/source/devref/dns_order.rst | 23 ++++++++++++++++++++++ doc/source/devref/layer3.rst | 23 ++++++++++++++++++++++ doc/source/devref/linuxbridge_agent.rst | 24 ++++++++++++++++++++++- doc/source/devref/openvswitch_agent.rst | 24 ++++++++++++++++++++++- doc/source/devref/oslo-incubator.rst | 23 ++++++++++++++++++++++ doc/source/devref/plugin-api.rst | 23 ++++++++++++++++++++++ doc/source/devref/policy.rst | 24 ++++++++++++++++++++++- doc/source/devref/quality_of_service.rst | 24 ++++++++++++++++++++++- doc/source/devref/quota.rst | 24 ++++++++++++++++++++++- doc/source/devref/rpc_api.rst | 24 ++++++++++++++++++++++- doc/source/devref/rpc_callbacks.rst | 24 ++++++++++++++++++++++- doc/source/devref/security_group_api.rst | 23 ++++++++++++++++++++++ doc/source/devref/services_and_agents.rst | 23 ++++++++++++++++++++++ doc/source/devref/sriov_nic_agent.rst | 24 ++++++++++++++++++++++- 19 files changed, 437 insertions(+), 10 deletions(-) diff --git a/doc/source/devref/advanced_services.rst b/doc/source/devref/advanced_services.rst index d96c2ff7f53..149986966df 100644 --- a/doc/source/devref/advanced_services.rst +++ b/doc/source/devref/advanced_services.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Advanced Services ================= diff --git a/doc/source/devref/api_extensions.rst b/doc/source/devref/api_extensions.rst index 2c8b3f64e94..f0c171b99ea 100644 --- a/doc/source/devref/api_extensions.rst +++ b/doc/source/devref/api_extensions.rst @@ -1,4 +1,26 @@ -============== +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + API Extensions ============== diff --git a/doc/source/devref/api_layer.rst b/doc/source/devref/api_layer.rst index a3e5e7f695f..dd23fb97533 100644 --- a/doc/source/devref/api_layer.rst +++ b/doc/source/devref/api_layer.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Neutron WSGI/HTTP API layer =========================== diff --git a/doc/source/devref/callbacks.rst b/doc/source/devref/callbacks.rst index acc3f7fc2dd..026d51d44e4 100644 --- a/doc/source/devref/callbacks.rst +++ b/doc/source/devref/callbacks.rst @@ -1,4 +1,26 @@ -======================= +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Neutron Callback System ======================= diff --git a/doc/source/devref/db_layer.rst b/doc/source/devref/db_layer.rst index 248c85e0b52..c1225419bfd 100644 --- a/doc/source/devref/db_layer.rst +++ b/doc/source/devref/db_layer.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Neutron Database Layer ====================== diff --git a/doc/source/devref/dns_order.rst b/doc/source/devref/dns_order.rst index bb8397081c6..cdac01464a2 100644 --- a/doc/source/devref/dns_order.rst +++ b/doc/source/devref/dns_order.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Keep DNS Nameserver Order Consistency In Neutron ================================================ diff --git a/doc/source/devref/layer3.rst b/doc/source/devref/layer3.rst index 809940722ec..e382c17ed73 100644 --- a/doc/source/devref/layer3.rst +++ b/doc/source/devref/layer3.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Layer 3 Networking in Neutron - via Layer 3 agent & OpenVSwitch =============================================================== diff --git a/doc/source/devref/linuxbridge_agent.rst b/doc/source/devref/linuxbridge_agent.rst index ef21cf4a8ae..e6a13716fe3 100644 --- a/doc/source/devref/linuxbridge_agent.rst +++ b/doc/source/devref/linuxbridge_agent.rst @@ -1,4 +1,26 @@ -=============================== +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + L2 Networking with Linux Bridge =============================== diff --git a/doc/source/devref/openvswitch_agent.rst b/doc/source/devref/openvswitch_agent.rst index 177520071bc..62104cd190f 100644 --- a/doc/source/devref/openvswitch_agent.rst +++ b/doc/source/devref/openvswitch_agent.rst @@ -1,4 +1,26 @@ -==================== +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + OpenVSwitch L2 Agent ==================== diff --git a/doc/source/devref/oslo-incubator.rst b/doc/source/devref/oslo-incubator.rst index 929d7b7da86..ddc2a5de044 100644 --- a/doc/source/devref/oslo-incubator.rst +++ b/doc/source/devref/oslo-incubator.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + oslo-incubator ============== diff --git a/doc/source/devref/plugin-api.rst b/doc/source/devref/plugin-api.rst index bec544b0e3d..7bb68d02287 100644 --- a/doc/source/devref/plugin-api.rst +++ b/doc/source/devref/plugin-api.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Neutron Plugin Architecture =========================== diff --git a/doc/source/devref/policy.rst b/doc/source/devref/policy.rst index 692191ec501..83a1c891bad 100644 --- a/doc/source/devref/policy.rst +++ b/doc/source/devref/policy.rst @@ -1,4 +1,26 @@ -================================== +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Authorization Policy Enforcement ================================== diff --git a/doc/source/devref/quality_of_service.rst b/doc/source/devref/quality_of_service.rst index e3a6dd98f4f..a1ab020f179 100644 --- a/doc/source/devref/quality_of_service.rst +++ b/doc/source/devref/quality_of_service.rst @@ -1,4 +1,26 @@ -================== +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Quality of Service ================== diff --git a/doc/source/devref/quota.rst b/doc/source/devref/quota.rst index ae0f9927910..a32b12de326 100644 --- a/doc/source/devref/quota.rst +++ b/doc/source/devref/quota.rst @@ -1,4 +1,26 @@ -================================ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Quota Management and Enforcement ================================ diff --git a/doc/source/devref/rpc_api.rst b/doc/source/devref/rpc_api.rst index 5a417ab7881..1a5fca034b7 100644 --- a/doc/source/devref/rpc_api.rst +++ b/doc/source/devref/rpc_api.rst @@ -1,4 +1,26 @@ -===================== +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Neutron RPC API Layer ===================== diff --git a/doc/source/devref/rpc_callbacks.rst b/doc/source/devref/rpc_callbacks.rst index f72672482b3..97ca772aec4 100644 --- a/doc/source/devref/rpc_callbacks.rst +++ b/doc/source/devref/rpc_callbacks.rst @@ -1,4 +1,26 @@ -================================= +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Neutron Messaging Callback System ================================= diff --git a/doc/source/devref/security_group_api.rst b/doc/source/devref/security_group_api.rst index c888424f7ba..72bc3977b0e 100644 --- a/doc/source/devref/security_group_api.rst +++ b/doc/source/devref/security_group_api.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Guided Tour: The Neutron Security Group API =========================================== diff --git a/doc/source/devref/services_and_agents.rst b/doc/source/devref/services_and_agents.rst index c7bc09eaa86..39d05735b7c 100644 --- a/doc/source/devref/services_and_agents.rst +++ b/doc/source/devref/services_and_agents.rst @@ -1,3 +1,26 @@ +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + Services and agents =================== diff --git a/doc/source/devref/sriov_nic_agent.rst b/doc/source/devref/sriov_nic_agent.rst index a316877b071..bc63e96477a 100644 --- a/doc/source/devref/sriov_nic_agent.rst +++ b/doc/source/devref/sriov_nic_agent.rst @@ -1,4 +1,26 @@ -====================================== +.. + Licensed 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. + + + Convention for heading levels in Neutron devref: + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + (Avoid deeper levels because they do not render well.) + + L2 Networking with SR-IOV enabled NICs ====================================== SR-IOV (Single Root I/O Virtualization) is a specification that allows