Browse Source

Replaces Copyright statements for LLC with Foundation, removes date.

Replaced GA code for cross-domain tracking.

Patchset addresses reviewer's comments
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright

Adds current year to each Sphinx-built page.

Addresses only the docs copyright attribution, not code files.

Change-Id: Ib90fd1c92c8fafce2db821bc2b17cef1377cfc1e
changes/89/18889/4
annegentle 9 years ago
parent
commit
72428434f7
  1. 2
      doc/manpages/account-server.conf.5
  2. 2
      doc/manpages/container-server.conf.5
  3. 2
      doc/manpages/dispersion.conf.5
  4. 2
      doc/manpages/object-expirer.conf.5
  5. 2
      doc/manpages/object-server.conf.5
  6. 2
      doc/manpages/proxy-server.conf.5
  7. 2
      doc/manpages/swift-account-auditor.1
  8. 2
      doc/manpages/swift-account-reaper.1
  9. 2
      doc/manpages/swift-account-replicator.1
  10. 2
      doc/manpages/swift-account-server.1
  11. 2
      doc/manpages/swift-container-auditor.1
  12. 2
      doc/manpages/swift-container-replicator.1
  13. 2
      doc/manpages/swift-container-server.1
  14. 2
      doc/manpages/swift-container-sync.1
  15. 2
      doc/manpages/swift-container-updater.1
  16. 11
      doc/manpages/swift-dispersion-populate.1
  17. 14
      doc/manpages/swift-dispersion-report.1
  18. 10
      doc/manpages/swift-get-nodes.1
  19. 5
      doc/manpages/swift-init.1
  20. 2
      doc/manpages/swift-object-auditor.1
  21. 2
      doc/manpages/swift-object-expirer.1
  22. 2
      doc/manpages/swift-object-info.1
  23. 2
      doc/manpages/swift-object-replicator.1
  24. 2
      doc/manpages/swift-object-server.1
  25. 2
      doc/manpages/swift-object-updater.1
  26. 2
      doc/manpages/swift-orphans.1
  27. 2
      doc/manpages/swift-proxy-server.1
  28. 2
      doc/manpages/swift-recon.1
  29. 5
      doc/manpages/swift-ring-builder.1
  30. 23
      doc/manpages/swift.1
  31. 5
      doc/source/_ga/layout.html
  32. 5
      doc/source/conf.py
  33. 9
      doc/source/development_guidelines.rst

2
doc/manpages/account-server.conf.5

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/container-server.conf.5

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/dispersion.conf.5

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/object-expirer.conf.5

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2012 OpenStack, LLC.
.\" Copyright (c) 2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/object-server.conf.5

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/proxy-server.conf.5

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-account-auditor.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-account-reaper.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-account-replicator.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-account-server.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-container-auditor.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-container-replicator.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-container-server.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-container-sync.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-container-updater.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

11
doc/manpages/swift-dispersion-populate.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
@ -71,16 +71,19 @@ Example \fI/etc/swift/dispersion.conf\fR:
.IP "# concurrency = 25"
.RE
.PD
.SH EXAMPLE
.SH EXAMPLE
.PP
.PD 0
$ swift-dispersion-populate
.RS 1
.IP "Created 2621 containers for dispersion reporting, 38s, 0 retries"
.IP "Created 2621 objects for dispersion reporting, 27s, 0 retries"
.RE
.RE
.PD
.SH DOCUMENTATION
.LP
More in depth documentation about the swift-dispersion utilities and

14
doc/manpages/swift-dispersion-report.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
@ -100,11 +100,13 @@ Example \fI/etc/swift/dispersion.conf\fR:
.IP "# dump_json = no"
.RE
.PD
.SH EXAMPLE
.SH EXAMPLE
.PP
.PD 0
$ swift-dispersion-report
.RS 1
.IP "Queried 2622 containers for dispersion reporting, 31s, 0 retries"
.IP "100.00% of container copies found (7866 of 7866)"
@ -113,9 +115,11 @@ $ swift-dispersion-report
.IP "Queried 2621 objects for dispersion reporting, 22s, 0 retries"
.IP "100.00% of object copies found (7863 of 7863)"
.IP "Sample represents 1.00% of the object partition space"
.RE
.RE
.PD
.SH DOCUMENTATION
.LP
More in depth documentation about the swift-dispersion utilities and

10
doc/manpages/swift-get-nodes.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
@ -55,14 +55,18 @@ where the container resides by using the container ring.
.IP "Server:Port Device 172.24.24.27:6002 sdr"
.IP "Server:Port Device 172.24.24.32:6002 sde"
.IP "Server:Port Device 172.24.24.26:6002 sdv [Handoff]"
.IP "curl -I -XHEAD http://172.24.24.29:6002/sdd/221082/MyAccount-12ac01446be2"
.IP "curl -I -XHEAD http://172.24.24.27:6002/sdr/221082/MyAccount-12ac01446be2"
.IP "curl -I -XHEAD http://172.24.24.32:6002/sde/221082/MyAccount-12ac01446be2"
.IP "curl -I -XHEAD http://172.24.24.26:6002/sdv/221082/MyAccount-12ac01446be2 # [Handoff]"
.IP "ssh 172.24.24.29 ls -lah /srv/node/sdd/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/ "
.IP "ssh 172.24.24.27 ls -lah /srv/node/sdr/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/" .IP "ssh 172.24.24.32 ls -lah /srv/node/sde/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/" .IP "ssh 172.24.24.26 ls -lah /srv/node/sdv/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/ # [Handoff] "
.IP "ssh 172.24.24.27 ls -lah /srv/node/sdr/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/"
.IP "ssh 172.24.24.32 ls -lah /srv/node/sde/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/"
.IP "ssh 172.24.24.26 ls -lah /srv/node/sdv/accounts/221082/cce/d7e6ba68cfdce0f0e4ca7890e46cacce/ # [Handoff] "
.PD
.RE

5
doc/manpages/swift-init.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
@ -111,7 +111,8 @@ allows one to use the keywords such as "all", "main" and "rest" for the <server>
.IP "-r RUN_DIR, --run-dir=RUN_DIR directory where the pids will be stored (default /var/run/swift)
.PD
.RE
.SH DOCUMENTATION
.LP

2
doc/manpages/swift-object-auditor.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-object-expirer.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2012 OpenStack, LLC.
.\" Copyright (c) 2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-object-info.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-object-replicator.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-object-server.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-object-updater.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2012 OpenStack, LLC.
.\" Copyright (c) 2010-2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-orphans.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2012 OpenStack, LLC.
.\" Copyright (c) 2012 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-proxy-server.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

2
doc/manpages/swift-recon.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.

5
doc/manpages/swift-ring-builder.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
@ -204,7 +204,8 @@ calls when no rebalance is needed but you want to send out the new device inform
.PD
.SH DOCUMENTATION
.LP
More in depth documentation about the swift ring and also Openstack-Swift as a

23
doc/manpages/swift.1

@ -1,6 +1,6 @@
.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack, LLC.
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
@ -68,7 +68,8 @@ items to set in the form Name:Value. This option can be repeated.
\fBExample\fR: post -m Color:Blue -m Size:Large
.RE
\fBdownload\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
\fBdownload\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
.RS 4
Downloads everything in the account (with --all), or everything in a
container, or a list of objects depending on the args given. For a single
@ -76,14 +77,17 @@ object download, you may use the -o [--output] <filename> option to
redirect the output to a specific file or if "-" then just redirect to stdout.
.RE
\fBdelete\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
\fBdelete\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
.RS 4
Deletes everything in the account (with --all), or everything in a container,
or a list of objects depending on the args given. Segments of manifest objects
will be deleted as well, unless you specify the --leave-segments option.
will be deleted as well, unless you specify the --leave-segments option.
.RE
.SH OPTIONS
.SH OPTIONS
.PD 0
.IP "--version Show program's version number and exit"
.IP "-h, --help Show this help message and exit"
@ -92,10 +96,12 @@ will be deleted as well, unless you specify the --leave-segments option.
.IP "-q, --quiet Suppress status output"
.IP "-A AUTH, --auth=AUTH URL for obtaining an auth token "
.IP "-U USER, --user=USER User name for obtaining an auth token"
.IP "-K KEY, --key=KEY Key for obtaining an auth token"
.IP "-K KEY, --key=KEY Key for obtaining an auth token"
.PD
.SH EXAMPLE
.SH EXAMPLE
.PP
swift -A https://127.0.0.1:443/auth/v1.0 -U swiftops:swiftops -K swiftops stat
@ -110,7 +116,8 @@ swift -A https://127.0.0.1:443/auth/v1.0 -U swiftops:swiftops -K swiftops stat
.PD
.RE
.SH DOCUMENTATION
.LP
More in depth documentation about Openstack-Swift as a whole can be found at

5
doc/source/_ga/layout.html

@ -8,9 +8,8 @@ document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-17511903-4");
pageTracker._setDomainName("none");
pageTracker._setAllowLinker(true);
var pageTracker = _gat._getTracker("UA-17511903-1");
pageTracker._setCookiePath("/developer/swift");
pageTracker._trackPageview();
} catch(err) {}</script>
{% endblock %}

5
doc/source/conf.py

@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2010-2012 OpenStack, LLC.
# Copyright (c) 2010-2012 OpenStack Foundation.
#
# Swift documentation build configuration file, created by
# sphinx-quickstart on Tue May 18 13:50:15 2010.
@ -15,6 +15,7 @@
import sys
import os
import datetime
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@ -52,7 +53,7 @@ master_doc = 'index'
# General information about the project.
project = u'Swift'
copyright = u'2011-present, OpenStack, LLC'
copyright = u'%d, OpenStack Foundation' % datetime.datetime.now().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the

9
doc/source/development_guidelines.rst

@ -61,10 +61,13 @@ More specifically:
License and Copyright
---------------------
Every source file should have the following copyright and license statement at
the top::
You can have the following copyright and license statement at
the top of each source file. Copyright assignment is optional.
# Copyright (c) 2010-2012 OpenStack, LLC.
New files should contain the current year. Substantial updates can have
another year added, and date ranges are not needed.::
# Copyright (c) 2013 OpenStack Foundation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.

Loading…
Cancel
Save