openstack/glance
Code Issues Proposed changes

fix include directives

Browse Source 
Change-Id: I52720ce1c8c20df246ec8e381bc0da89efd5f0d6
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-06-15 14:20:53 -04:00
parent 2725850d5f
commit f252af6490
15 changed files with 39 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/cli/footer.rst → doc/source/cli/footer.txt
View File

@ -1,3 +1,5 @@
.. -*- mode: rst -*-
SEE ALSO
========

2
doc/source/cli/general_options.rst → doc/source/cli/general_options.txt
View File

@ -1,3 +1,5 @@
.. -*- mode: rst -*-
**-h, --help**
Show the help message and exit

6
doc/source/cli/glanceapi.rst
View File

@ -6,7 +6,7 @@ glance-api
Server for the Glance Image Service API
---------------------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -23,7 +23,7 @@ OPTIONS
**General options**
.. include:: general_options.rst
.. include:: general_options.txt
FILES
=====
@ -31,4 +31,4 @@ FILES
**/etc/glance/glance-api.conf**
Default configuration file for Glance API
.. include:: footer.rst
.. include:: footer.txt

6
doc/source/cli/glancecachecleaner.rst
View File

@ -6,7 +6,7 @@ glance-cache-cleaner
Glance Image Cache Invalid Cache Entry and Stalled Image cleaner
----------------------------------------------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -31,7 +31,7 @@ OPTIONS
**General options**
.. include:: general_options.rst
.. include:: general_options.txt
FILES
=====
@ -39,4 +39,4 @@ FILES
**/etc/glance/glance-cache.conf**
Default configuration file for the Glance Cache
.. include:: footer.rst
.. include:: footer.txt

6
doc/source/cli/glancecachemanage.rst
View File

@ -6,7 +6,7 @@ glance-cache-manage
Cache management utility
------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -78,6 +78,6 @@ OPTIONS
**-S STRATEGY, --os-auth-strategy=STRATEGY**
Authentication strategy (keystone or noauth)
.. include:: openstack_options.rst
.. include:: openstack_options.txt
.. include:: footer.rst
.. include:: footer.txt

6
doc/source/cli/glancecacheprefetcher.rst
View File

@ -6,7 +6,7 @@ glance-cache-prefetcher
Glance Image Cache Pre-fetcher
------------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -24,7 +24,7 @@ OPTIONS
**General options**
.. include:: general_options.rst
.. include:: general_options.txt
FILES
=====
@ -32,4 +32,4 @@ FILES
**/etc/glance/glance-cache.conf**
Default configuration file for the Glance Cache
.. include:: footer.rst
.. include:: footer.txt

6
doc/source/cli/glancecachepruner.rst
View File

@ -6,7 +6,7 @@ glance-cache-pruner
Glance cache pruner
-------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -25,7 +25,7 @@ OPTIONS
**General options**
.. include:: general_options.rst
.. include:: general_options.txt
FILES
=====
@ -33,4 +33,4 @@ FILES
**/etc/glance/glance-cache.conf**
Default configuration file for the Glance Cache
.. include:: footer.rst
.. include:: footer.txt

6
doc/source/cli/glancecontrol.rst
View File

@ -6,7 +6,7 @@ glance-control
Glance daemon start/stop/reload helper
--------------------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -28,7 +28,7 @@ OPTIONS
**General Options**
.. include:: general_options.rst
.. include:: general_options.txt
**--pid-file=PATH**
File to use as pid file. Default:
@ -50,4 +50,4 @@ OPTIONS
**--respawn**
Restart service on unexpected death
.. include:: footer.rst
.. include:: footer.txt

6
doc/source/cli/glancemanage.rst
View File

@ -6,7 +6,7 @@ glance-manage
Glance Management Utility
-------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -85,9 +85,9 @@ OPTIONS
**General Options**
.. include:: general_options.rst
.. include:: general_options.txt
.. include:: footer.rst
.. include:: footer.txt
CONFIGURATION
=============

6
doc/source/cli/glanceregistry.rst
View File

@ -6,7 +6,7 @@ glance-registry
Server for the Glance Registry Service
--------------------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -24,7 +24,7 @@ OPTIONS
**General options**
.. include:: general_options.rst
.. include:: general_options.txt
FILES
=====
@ -32,4 +32,4 @@ FILES
**/etc/glance/glance-registry.conf**
Default configuration file for Glance Registry
.. include:: footer.rst
.. include:: footer.txt

4
doc/source/cli/glancereplicator.rst
View File

@ -6,7 +6,7 @@ glance-replicator
Replicate images across multiple data centers
---------------------------------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -82,4 +82,4 @@ OPTIONS
**-v, --verbose**
Print more verbose output
.. include:: footer.rst
.. include:: footer.txt

6
doc/source/cli/glancescrubber.rst
View File

@ -6,7 +6,7 @@ glance-scrubber
Glance scrub service
--------------------
.. include:: header.rst
.. include:: header.txt
SYNOPSIS
========
@ -37,7 +37,7 @@ OPTIONS
**General options**
.. include:: general_options.rst
.. include:: general_options.txt
**-D, --daemon**
Run as a long-running process. When not specified (the
@ -55,4 +55,4 @@ FILES
**/etc/glance/glance-scrubber.conf**
Default configuration file for the Glance Scrubber
.. include:: footer.rst
.. include:: footer.txt

2
doc/source/cli/header.rst → doc/source/cli/header.txt
View File

@ -1,3 +1,5 @@
.. -*- mode: rst -*-
:Author: glance@lists.launchpad.net
:Date: 2017-09-15
:Copyright: OpenStack Foundation

2
doc/source/cli/openstack_options.rst → doc/source/cli/openstack_options.txt
View File

@ -1,3 +1,5 @@
.. -*- mode: rst -*-
**-os-auth-token=OS_AUTH_TOKEN**
Defaults to env[OS_AUTH_TOKEN]

4
doc/source/user/glanceapi.rst
View File

@ -20,7 +20,7 @@ Using Glance's Image Public APIs
Glance is the reference implementation of the OpenStack Images API. As such,
Glance fully implements versions 1 and 2 of the Images API.
.. include:: deprecation-note.inc
.. include:: ../deprecation-note.inc
There used to be a sentence here saying, "The Images API specification is
developed alongside Glance, but is not considered part of the Glance project."
@ -127,7 +127,7 @@ See :doc:`authentication` for more information on integrating with Keystone.
Using v1.X
----------
.. include:: deprecation-note.inc
.. include:: ../deprecation-note.inc
For the purpose of examples, assume there is a Glance API server running
at the URL ``http://glance.openstack.example.org`` on the default port 80.