From 82579cec966c3b8b0c2161c1946be01b6953f610 Mon Sep 17 00:00:00 2001
From: Zooko Wilcox-O'Hearn <zooko@zooko.com>
Date: Fri, 8 Nov 2013 20:31:08 +0000
Subject: [PATCH] magic first line tells emacs to use utf8+bom

Add ".. -*- coding: utf-8-with-signature -*-" to the first line of each .rst
file. This tells emacs to treat the file contents as utf-8, and also to prepend
a so-called utf-8 "bom" marker at the beginning of the file. This patch also
prepends those markers to each of those files.
---
 COPYING.TGPPL.rst                            | 4 +++-
 NEWS.rst                                     | 4 +++-
 docs/about.rst                               | 4 +---
 docs/architecture.rst                        | 2 ++
 docs/backdoors.rst                           | 2 ++
 docs/backupdb.rst                            | 2 ++
 docs/cautions.rst                            | 3 ++-
 docs/configuration.rst                       | 2 ++
 docs/convergence-secret.rst                  | 2 +-
 docs/debian.rst                              | 2 ++
 docs/filesystem-notes.rst                    | 2 ++
 docs/frontends/CLI.rst                       | 2 ++
 docs/frontends/FTP-and-SFTP.rst              | 2 ++
 docs/frontends/download-status.rst           | 2 ++
 docs/frontends/drop-upload.rst               | 2 ++
 docs/frontends/webapi.rst                    | 2 ++
 docs/garbage-collection.rst                  | 2 ++
 docs/helper.rst                              | 2 ++
 docs/historical/configuration.rst            | 2 ++
 docs/known_issues.rst                        | 3 ++-
 docs/logging.rst                             | 2 ++
 docs/nodekeys.rst                            | 2 ++
 docs/performance.rst                         | 2 ++
 docs/proposed/leasedb.rst                    | 3 ++-
 docs/quickstart.rst                          | 3 ++-
 docs/running.rst                             | 2 ++
 docs/specifications/URI-extension.rst        | 2 ++
 docs/specifications/backends/raic.rst        | 3 ++-
 docs/specifications/dirnodes.rst             | 2 ++
 docs/specifications/file-encoding.rst        | 2 ++
 docs/specifications/mutable.rst              | 2 ++
 docs/specifications/outline.rst              | 2 ++
 docs/specifications/servers-of-happiness.rst | 2 ++
 docs/specifications/uri.rst                  | 2 ++
 docs/stats.rst                               | 4 +++-
 docs/write_coordination.rst                  | 2 ++
 36 files changed, 73 insertions(+), 12 deletions(-)

diff --git a/COPYING.TGPPL.rst b/COPYING.TGPPL.rst
index e89b079f..5bcf0aa2 100644
--- a/COPYING.TGPPL.rst
+++ b/COPYING.TGPPL.rst
@@ -1,4 +1,6 @@
-This work also comes with the added permission that you may combine it with a
+.. -*- coding: utf-8-with-signature -*-
+
+This work also comes with the added permission that you may combine it with a
 work licensed under the OpenSSL license (any version) and distribute the
 resulting combined work, as long as you follow the requirements of the
 licences of this work in regard to all of the resulting combined work
diff --git a/NEWS.rst b/NEWS.rst
index 49f9eaf6..92182e4d 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -1,4 +1,6 @@
-==================================
+.. -*- coding: utf-8-with-signature -*-
+
+==================================
 User-Visible Changes in Tahoe-LAFS
 ==================================
 
diff --git a/docs/about.rst b/docs/about.rst
index 6e238882..c9594e27 100644
--- a/docs/about.rst
+++ b/docs/about.rst
@@ -1,6 +1,4 @@
-
-
-.. -*- coding: utf-8 -*-
+.. -*- coding: utf-8-with-signature -*-
 
 Welcome to Tahoe-LAFS!
 ======================
diff --git a/docs/architecture.rst b/docs/architecture.rst
index 85acb31d..98c70faa 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 Tahoe-LAFS Architecture
 =======================
diff --git a/docs/backdoors.rst b/docs/backdoors.rst
index 031c8715..97716fca 100644
--- a/docs/backdoors.rst
+++ b/docs/backdoors.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 Statement on Backdoors
 ======================
 
diff --git a/docs/backupdb.rst b/docs/backupdb.rst
index 5a36b518..659c2fd7 100644
--- a/docs/backupdb.rst
+++ b/docs/backupdb.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==================
 The Tahoe BackupDB
 ==================
diff --git a/docs/cautions.rst b/docs/cautions.rst
index 7aee35c0..ae0281f9 100644
--- a/docs/cautions.rst
+++ b/docs/cautions.rst
@@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature -*-
+
 =======================================================
  Things To Be Careful About As We Venture Boldly Forth
 =======================================================
diff --git a/docs/configuration.rst b/docs/configuration.rst
index f3db2980..a0022df6 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============================
 Configuring a Tahoe-LAFS node
 =============================
diff --git a/docs/convergence-secret.rst b/docs/convergence-secret.rst
index d4fe5117..e94392bb 100644
--- a/docs/convergence-secret.rst
+++ b/docs/convergence-secret.rst
@@ -1,4 +1,4 @@
-
+.. -*- coding: utf-8-with-signature -*-
 
 What Is It?
 -----------
diff --git a/docs/debian.rst b/docs/debian.rst
index cee6b445..31aabff3 100644
--- a/docs/debian.rst
+++ b/docs/debian.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =========================
 Debian and Ubuntu Support
 =========================
diff --git a/docs/filesystem-notes.rst b/docs/filesystem-notes.rst
index 6128e204..9c019fbb 100644
--- a/docs/filesystem-notes.rst
+++ b/docs/filesystem-notes.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =========================
 Filesystem-specific notes
 =========================
diff --git a/docs/frontends/CLI.rst b/docs/frontends/CLI.rst
index ebeb34c9..96927dbe 100644
--- a/docs/frontends/CLI.rst
+++ b/docs/frontends/CLI.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===========================
 The Tahoe-LAFS CLI commands
 ===========================
diff --git a/docs/frontends/FTP-and-SFTP.rst b/docs/frontends/FTP-and-SFTP.rst
index acec6c84..3b418a57 100644
--- a/docs/frontends/FTP-and-SFTP.rst
+++ b/docs/frontends/FTP-and-SFTP.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =================================
 Tahoe-LAFS SFTP and FTP Frontends
 =================================
diff --git a/docs/frontends/download-status.rst b/docs/frontends/download-status.rst
index 4de60f54..cc82551a 100644
--- a/docs/frontends/download-status.rst
+++ b/docs/frontends/download-status.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===============
 Download status
 ===============
diff --git a/docs/frontends/drop-upload.rst b/docs/frontends/drop-upload.rst
index 0cc6be21..8d92052c 100644
--- a/docs/frontends/drop-upload.rst
+++ b/docs/frontends/drop-upload.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===============================
 Tahoe-LAFS Drop-Upload Frontend
 ===============================
diff --git a/docs/frontends/webapi.rst b/docs/frontends/webapi.rst
index 046d2c59..1d3b33c6 100644
--- a/docs/frontends/webapi.rst
+++ b/docs/frontends/webapi.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==========================
 The Tahoe REST-ful Web API
 ==========================
diff --git a/docs/garbage-collection.rst b/docs/garbage-collection.rst
index f1ae44cc..716dcdc2 100644
--- a/docs/garbage-collection.rst
+++ b/docs/garbage-collection.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===========================
 Garbage Collection in Tahoe
 ===========================
diff --git a/docs/helper.rst b/docs/helper.rst
index ae5d4418..240db8a1 100644
--- a/docs/helper.rst
+++ b/docs/helper.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 The Tahoe Upload Helper
 =======================
diff --git a/docs/historical/configuration.rst b/docs/historical/configuration.rst
index ca58b59f..660bc848 100644
--- a/docs/historical/configuration.rst
+++ b/docs/historical/configuration.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 Old Configuration Files
 =======================
diff --git a/docs/known_issues.rst b/docs/known_issues.rst
index 30918d63..af0e5b46 100644
--- a/docs/known_issues.rst
+++ b/docs/known_issues.rst
@@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature -*-
+
 See also `cautions.rst`_.
 
 .. _cautions.rst: cautions.rst
diff --git a/docs/logging.rst b/docs/logging.rst
index 8822787d..4672e8f9 100644
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============
 Tahoe Logging
 =============
diff --git a/docs/nodekeys.rst b/docs/nodekeys.rst
index 6ea5eb39..a5b73a99 100644
--- a/docs/nodekeys.rst
+++ b/docs/nodekeys.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 Node Keys in Tahoe-LAFS
 =======================
diff --git a/docs/performance.rst b/docs/performance.rst
index d9bd28ff..6ddeb1fe 100644
--- a/docs/performance.rst
+++ b/docs/performance.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ============================================
 Performance costs for some common operations
 ============================================
diff --git a/docs/proposed/leasedb.rst b/docs/proposed/leasedb.rst
index bbd0e92a..c0516c31 100644
--- a/docs/proposed/leasedb.rst
+++ b/docs/proposed/leasedb.rst
@@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature -*-
+
 =====================
 Lease database design
 =====================
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
index fda22c2c..04591334 100644
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature -*-
+
 ==================
 Getting Tahoe-LAFS
 ==================
diff --git a/docs/running.rst b/docs/running.rst
index 50ad2cb4..0d3836e6 100644
--- a/docs/running.rst
+++ b/docs/running.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =====================
 How To Run Tahoe-LAFS
 =====================
diff --git a/docs/specifications/URI-extension.rst b/docs/specifications/URI-extension.rst
index 6d40652e..f225e510 100644
--- a/docs/specifications/URI-extension.rst
+++ b/docs/specifications/URI-extension.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===================
 URI Extension Block
 ===================
diff --git a/docs/specifications/backends/raic.rst b/docs/specifications/backends/raic.rst
index 92a4ec13..ed88307e 100644
--- a/docs/specifications/backends/raic.rst
+++ b/docs/specifications/backends/raic.rst
@@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature -*-
+
 =============================================================
 Redundant Array of Independent Clouds: Share To Cloud Mapping
 =============================================================
diff --git a/docs/specifications/dirnodes.rst b/docs/specifications/dirnodes.rst
index e68b02f6..4ea3ae48 100644
--- a/docs/specifications/dirnodes.rst
+++ b/docs/specifications/dirnodes.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==========================
 Tahoe-LAFS Directory Nodes
 ==========================
diff --git a/docs/specifications/file-encoding.rst b/docs/specifications/file-encoding.rst
index 1f2ee748..b11ef329 100644
--- a/docs/specifications/file-encoding.rst
+++ b/docs/specifications/file-encoding.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============
 File Encoding
 =============
diff --git a/docs/specifications/mutable.rst b/docs/specifications/mutable.rst
index ea7ac49b..09e25f32 100644
--- a/docs/specifications/mutable.rst
+++ b/docs/specifications/mutable.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============
 Mutable Files
 =============
diff --git a/docs/specifications/outline.rst b/docs/specifications/outline.rst
index 9ec69bff..6fb53492 100644
--- a/docs/specifications/outline.rst
+++ b/docs/specifications/outline.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==============================
 Specification Document Outline
 ==============================
diff --git a/docs/specifications/servers-of-happiness.rst b/docs/specifications/servers-of-happiness.rst
index 7f0029be..18d384ae 100644
--- a/docs/specifications/servers-of-happiness.rst
+++ b/docs/specifications/servers-of-happiness.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ====================
 Servers of Happiness
 ====================
diff --git a/docs/specifications/uri.rst b/docs/specifications/uri.rst
index b05be23b..1953a111 100644
--- a/docs/specifications/uri.rst
+++ b/docs/specifications/uri.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==========
 Tahoe URIs
 ==========
diff --git a/docs/stats.rst b/docs/stats.rst
index 1a4699d0..76310841 100644
--- a/docs/stats.rst
+++ b/docs/stats.rst
@@ -1,4 +1,6 @@
-================
+.. -*- coding: utf-8-with-signature -*-
+
+================
 Tahoe Statistics
 ================
 
diff --git a/docs/write_coordination.rst b/docs/write_coordination.rst
index e855aec4..4c0d319d 100644
--- a/docs/write_coordination.rst
+++ b/docs/write_coordination.rst
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==================================
 Avoiding Write Collisions in Tahoe
 ==================================
-- 
2.45.2