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.
2024-12-18 20:47:54 +00:00 · 2013-11-08 20:31:08 +00:00 · 2013-11-08 20:31:08 +00:00 · 82579cec96
commit 82579cec96
parent 2ac43975ee
36 changed files with 73 additions and 12 deletions
--- 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
--- a/NEWS.rst
+++ b/NEWS.rst
@ -1,4 +1,6 @@
-==================================
+.. -*- coding: utf-8-with-signature -*-
+
+==================================
 User-Visible Changes in Tahoe-LAFS
 ==================================

--- a/docs/about.rst
+++ b/docs/about.rst
@ -1,6 +1,4 @@
-
-
-.. -*- coding: utf-8 -*-
+.. -*- coding: utf-8-with-signature -*-

 Welcome to Tahoe-LAFS!
 ======================
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 Tahoe-LAFS Architecture
 =======================
--- a/docs/backdoors.rst
+++ b/docs/backdoors.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 Statement on Backdoors
 ======================

--- a/docs/backupdb.rst
+++ b/docs/backupdb.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==================
 The Tahoe BackupDB
 ==================
--- 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
 =======================================================
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============================
 Configuring a Tahoe-LAFS node
 =============================
--- a/docs/convergence-secret.rst
+++ b/docs/convergence-secret.rst
@ -1,4 +1,4 @@
-
+.. -*- coding: utf-8-with-signature -*-

 What Is It?
 -----------
--- a/docs/debian.rst
+++ b/docs/debian.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =========================
 Debian and Ubuntu Support
 =========================
--- a/docs/filesystem-notes.rst
+++ b/docs/filesystem-notes.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =========================
 Filesystem-specific notes
 =========================
--- a/docs/frontends/CLI.rst
+++ b/docs/frontends/CLI.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===========================
 The Tahoe-LAFS CLI commands
 ===========================
--- 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
 =================================
--- a/docs/frontends/download-status.rst
+++ b/docs/frontends/download-status.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===============
 Download status
 ===============
--- 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
 ===============================
--- 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
 ==========================
--- a/docs/garbage-collection.rst
+++ b/docs/garbage-collection.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===========================
 Garbage Collection in Tahoe
 ===========================
--- a/docs/helper.rst
+++ b/docs/helper.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 The Tahoe Upload Helper
 =======================
--- a/docs/historical/configuration.rst
+++ b/docs/historical/configuration.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 Old Configuration Files
 =======================
--- 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
--- a/docs/logging.rst
+++ b/docs/logging.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============
 Tahoe Logging
 =============
--- a/docs/nodekeys.rst
+++ b/docs/nodekeys.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =======================
 Node Keys in Tahoe-LAFS
 =======================
--- a/docs/performance.rst
+++ b/docs/performance.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ============================================
 Performance costs for some common operations
 ============================================
--- a/docs/proposed/leasedb.rst
+++ b/docs/proposed/leasedb.rst
@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature -*-
+
 =====================
 Lease database design
 =====================
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@ -1,4 +1,5 @@
-
+.. -*- coding: utf-8-with-signature -*-
+
 ==================
 Getting Tahoe-LAFS
 ==================
--- a/docs/running.rst
+++ b/docs/running.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =====================
 How To Run Tahoe-LAFS
 =====================
--- a/docs/specifications/URI-extension.rst
+++ b/docs/specifications/URI-extension.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ===================
 URI Extension Block
 ===================
--- 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
 =============================================================
--- a/docs/specifications/dirnodes.rst
+++ b/docs/specifications/dirnodes.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==========================
 Tahoe-LAFS Directory Nodes
 ==========================
--- a/docs/specifications/file-encoding.rst
+++ b/docs/specifications/file-encoding.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============
 File Encoding
 =============
--- a/docs/specifications/mutable.rst
+++ b/docs/specifications/mutable.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 =============
 Mutable Files
 =============
--- a/docs/specifications/outline.rst
+++ b/docs/specifications/outline.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==============================
 Specification Document Outline
 ==============================
--- 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
 ====================
--- a/docs/specifications/uri.rst
+++ b/docs/specifications/uri.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==========
 Tahoe URIs
 ==========
--- a/docs/stats.rst
+++ b/docs/stats.rst
@ -1,4 +1,6 @@
-================
+.. -*- coding: utf-8-with-signature -*-
+
+================
 Tahoe Statistics
 ================

--- a/docs/write_coordination.rst
+++ b/docs/write_coordination.rst
@ -1,3 +1,5 @@
+.. -*- coding: utf-8-with-signature -*-
+
 ==================================
 Avoiding Write Collisions in Tahoe
 ==================================