[elpa] externals/topspace 851737dfe3 161/181: Prepare `topspace` for inclusion in GNU ELPA

[ELPA Syncer]

branch: externals/topspace
commit 851737dfe3dbd6ea5186d6d421d9d0c9197831ec
Author: Trevor Pogue <poguete@mcmaster.ca>
Commit: Trevor Pogue <poguete@mcmaster.ca>

    Prepare `topspace` for inclusion in GNU ELPA
    
    Other changes not related to preparing for GNU ELPA:
    - Add comment to `topspace--post-command` for clarification
    - Change CI name from Test to CI and test.yml to ci.yml
    - Bump version 0.2.1 -> 0.3.0
---
 .elpaignore                                   |  7 +++
 .github/workflows/{test.yml => ci.yml}        |  4 +-
 .github/workflows/{changelog.yml => news.yml} | 14 +++--
 CHANGELOG.md                                  | 79 ---------------------------
 CONTRIBUTING.md                               | 21 ++++++-
 README.md                                     |  4 +-
 topspace.el                                   | 19 ++++---
 7 files changed, 49 insertions(+), 99 deletions(-)

diff --git a/.elpaignore b/.elpaignore
new file mode 100644
index 0000000000..084c9e018f
--- /dev/null
+++ b/.elpaignore
@@ -0,0 +1,7 @@
+.github
+.gitignore
+test
+company-tests.el
+Cask
+CONTRIBUTING.md
+HISTORY.md
\ No newline at end of file
diff --git a/.github/workflows/test.yml b/.github/workflows/ci.yml
similarity index 96%
rename from .github/workflows/test.yml
rename to .github/workflows/ci.yml
index c26fa0c799..9a21b9689f 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/ci.yml
@@ -1,4 +1,4 @@
-name: Test
+name: CI
 
 on: [ push, pull_request ]
 jobs:
@@ -18,7 +18,7 @@ jobs:
         version: ${{ matrix.emacs_version }}
     - uses: conao3/setup-cask@master
     - uses: actions/checkout@v2
-    - name: Test
+    - name: CI
       env:
         COVERALLS_FLAG_NAME: Emacs ${{ matrix.emacs_version }}
         COVERALLS_PARALLEL: 1
diff --git a/.github/workflows/changelog.yml b/.github/workflows/news.yml
similarity index 64%
rename from .github/workflows/changelog.yml
rename to .github/workflows/news.yml
index f89e24b5df..d7aa5584cd 100644
--- a/.github/workflows/changelog.yml
+++ b/.github/workflows/news.yml
@@ -1,8 +1,8 @@
-name: Changelog
+name: News
 on:
   push:
     branches:
-      - main
+      - '*'
   release:
     types:
       - created
@@ -13,17 +13,19 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: "✏️ Generate changelog"
+      - name: "✏️ Generate news"
         uses: heinrichreimer/github-changelog-generator-action@v2.3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           sinceTag: v0.1.2
+          headerLabel: '# History of user-visible changes'
+          output: NEWS.md
           base: HISTORY.md
           issues: no
-#          futureRelease: v0.2.1
+          futureRelease: v0.3.0
 
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
-          commit_message: Update Changelog
-          file_pattern: CHANGELOG.md
+          commit_message: Update NEWS.md
+          file_pattern: NEWS.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index 8eaaee81e3..0000000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,79 +0,0 @@
-# Changelog
-
-## [Unreleased](https://github.com/trevorpogue/topspace/tree/HEAD)
-
-[Full Changelog](https://github.com/trevorpogue/topspace/compare/v0.2.1...HEAD)
-
-**Implemented enhancements:**
-
-- Add `topspace-set-height`, enhance `topspace-center-position` 
[\#19](https://github.com/trevorpogue/topspace/pull/19) 
([trevorpogue](https://github.com/trevorpogue))
-- Add `topspace-height` function for use by external packages 
[\#15](https://github.com/trevorpogue/topspace/pull/15) 
([trevorpogue](https://github.com/trevorpogue))
-- Add support for `smooth-scrolling` package 
[\#14](https://github.com/trevorpogue/topspace/pull/14) 
([trevorpogue](https://github.com/trevorpogue))
-
-**Fixed bugs:**
-
-- Fix unexpected top space height change when echo area height changes 
[\#18](https://github.com/trevorpogue/topspace/pull/18) 
([trevorpogue](https://github.com/trevorpogue))
-
-## [v0.2.1](https://github.com/trevorpogue/topspace/tree/v0.2.1) (2022-04-15)
-
-[Full 
Changelog](https://github.com/trevorpogue/topspace/compare/v0.2.0...v0.2.1)
-
-**Fixed bugs:**
-
-- Prevent "Beginning of buffer" error message when scrolling above top 
[\#12](https://github.com/trevorpogue/topspace/pull/12) 
([trevorpogue](https://github.com/trevorpogue))
-- Fix inability to use scrolling commands interactively 
[\#11](https://github.com/trevorpogue/topspace/pull/11) 
([trevorpogue](https://github.com/trevorpogue))
-
-## [v0.2.0](https://github.com/trevorpogue/topspace/tree/v0.2.0) (2022-04-12)
-
-[Full 
Changelog](https://github.com/trevorpogue/topspace/compare/v0.1.2...v0.2.0)
-
-**Implemented enhancements:**
-
-- Put topspace-empty-line-indicator inside left fringe 
[\#9](https://github.com/trevorpogue/topspace/pull/9) 
([trevorpogue](https://github.com/trevorpogue))
-- Add topspace-empty-line-indicator defcustom 
[\#8](https://github.com/trevorpogue/topspace/pull/8) 
([trevorpogue](https://github.com/trevorpogue))
-- Add `topspace-active`, improve `topspace-autocenter-buffers` 
[\#4](https://github.com/trevorpogue/topspace/pull/4) 
([trevorpogue](https://github.com/trevorpogue))
-
-**Fixed bugs:**
-
-- Support buffers with varying line heights 
[\#10](https://github.com/trevorpogue/topspace/pull/10) 
([trevorpogue](https://github.com/trevorpogue))
-- Fix bug where topspace-mode doesn't work locally 
[\#6](https://github.com/trevorpogue/topspace/pull/6) 
([trevorpogue](https://github.com/trevorpogue))
-
-## [v0.1.2](https://github.com/trevorpogue/topspace/tree/v0.1.2) (2022-03-01)
-
-[Full 
Changelog](https://github.com/trevorpogue/topspace/compare/v0.1.1...v0.1.2)
-
-**Fixed bugs:**
-* [#2](https://github.com/trevorpogue/topspace/pull/2): Make 
`recenter-top-bottom` act correctly when it moves point to bottom and top space 
is added to get there
-
-**Other changes:**
-
-* 
[2584138](https://github.com/trevorpogue/topspace/commit/25841387a5d0300ea49356b9781c357b84df20bd):
 Raise topspace-center-position default to a subjectively better position
-
-## [v0.1.1](https://github.com/trevorpogue/topspace/tree/v0.1.1) (2022-02-22)
-
-[Full 
Changelog](https://github.com/trevorpogue/topspace/compare/v0.1.0...v0.1.1)
-
-**Fixed bugs:**
-
-* 
[4a69b2e](https://github.com/trevorpogue/topspace/commit/4a69b2eb741f8db9d69169a03a6724af0f2ec7ac):
 Allow recenter and recenter-top-bottom to be called interactively without an 
error
-* 
[4eb27ab](https://github.com/trevorpogue/topspace/commit/4eb27abaa182e856ba3f3c8e1e84fdd2e1f009af):
 Prevent top space from all suddenly disappearing when visual-line-mode is 
enabled and cursor scrolls bellow window-end when top space is present
-
-## [v0.1.0](https://github.com/trevorpogue/topspace/tree/v0.1.0) (2022-02-19)
-
-[Full 
Changelog](https://github.com/trevorpogue/topspace/compare/79aa4e78d3f5c90fc9db46d597f1680c7900b52a...v0.1.0)
-
-**Implemented enhancements:**
-
-* [#1](https://github.com/trevorpogue/topspace/pull/1): Make mode work for any 
scrolling command by using add-advice with scroll-up, scroll-down, and recenter
-
-
-**Fixed bugs:**
-
-* [#1](https://github.com/trevorpogue/topspace/pull/1): Stabilize, clean up, 
and add performance optimizations to code to make it ready for submission to 
MELPA
-
-**Other changes:**
-
-* 
[e5b65ec](https://github.com/trevorpogue/topspace/commit/e5b65eccf92571163aa1b6bd738be22d8e0ad1a5):
 Change project name from vertical-center-mode to topspace
-
-
-\* *This Changelog was automatically generated by 
[github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 14b9f7da29..af4134efc2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,15 +32,32 @@ Try to follow the following guidelines if you open an issue 
or pull request:
   and description in grammatically correct, complete sentences.
 
 ## Running Tests
-Check [test.yml][5] to see the latest testing frameworks being used, and the 
command(s) required to run the tests. When last updating this file, cask and 
buttercup were being used to run the tests like so:
+Check [ci.yml][5] to see all the details for the testing frameworks being 
used, the Emacs versions being tested, and the command(s) required to run the 
tests. 
+TLDR: Cask and buttercup are used for testing and can be run like so:
 
 ```
 cask install
 cask exec buttercup -L .
 ```
 
+## Copyright Assignment
+This package is subject to the same 
[[https://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html][Copyright 
Assignment]] policy as
+GNU Emacs and all other packages in [[https://elpa.gnu.org/packages/][GNU 
ELPA]].
+
+Any 
[[https://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant][legally
 significant]] contributions can only be accepted after the
+author has completed their paperwork.  Please see 
[[https://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/Copyright/request-assign.future][the
 request form]] if
+you want to proceed with the assignment.
+
+The copyright assignment isn't a big deal, it just says that the
+copyright for your submitted changes to Emacs belongs to the FSF.
+This assignment works for all projects related to Emacs.  To obtain it
+you need to:
+* Send one email
+* Send one letter (if you live in the US, it's digital)
+* Wait for some time (recently it's less than a week)
+
 [1]: https://github.com/trevorpogue/topspace/issues
 [2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
 [3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 [4]: https://help.github.com/articles/using-pull-requests
-[5]: 
https://github.com/trevorpogue/topspace/blob/main/.github/workflows/test.yml
+[5]: https://github.com/trevorpogue/topspace/blob/main/.github/workflows/ci.yml
diff --git a/README.md b/README.md
index 00adb0739d..5b5932c60f 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@
 <!-- cursor -->
 
 <p align="center">
-   <a 
href="https://github.com/trevorpogue/topspace/actions/workflows/test.yml/";><img 
src="https://github.com/trevorpogue/topspace/actions/workflows/test.yml/badge.svg";
 height="20"/></a>
+   <a 
href="https://github.com/trevorpogue/topspace/actions/workflows/ci.yml/";><img 
src="https://github.com/trevorpogue/topspace/actions/workflows/ci.yml/badge.svg";
 height="20"/></a>
   <a href='https://coveralls.io/github/trevorpogue/topspace?branch=main'><img 
src='https://coveralls.io/repos/github/trevorpogue/topspace/badge.svg?branch=main&1'
 alt='Coverage Status' /></a>
-  <a 
href="https://github.com/trevorpogue/topspace/blob/main/.github/workflows/test.yml";><img
 
src="https://img.shields.io/badge/Emacs-25.1+-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=whit";
 height="20"/></a>
+  <a 
href="https://github.com/trevorpogue/topspace/blob/main/.github/workflows/ci.yml";><img
 
src="https://img.shields.io/badge/Emacs-25.1+-blueviolet.svg?style=flat-square&logo=GNU%20Emacs&logoColor=whit";
 height="20"/></a>
   <a href="http://melpa.org/#/topspace";><img 
src="http://melpa.org/packages/topspace-badge.svg"; height="20"/></a>
   <a href="http://stable.melpa.org/#/topspace";><img 
src="http://stable.melpa.org/packages/topspace-badge.svg"; height="20"/></a>
 
diff --git a/topspace.el b/topspace.el
index 23debe26cc..e890083e4e 100644
--- a/topspace.el
+++ b/topspace.el
@@ -1,28 +1,31 @@
 ;;; topspace.el --- Scroll down & recenter top lines / get upper 
margins/padding -*- lexical-binding: t -*-
 
-;; Copyright (C) 2021-2022 Trevor Edwin Pogue
+;; Copyright (C) 2021-2022 Free Software Foundation, Inc.
 
 ;; Author: Trevor Edwin Pogue <trevor.pogue@gmail.com>
 ;; Maintainer: Trevor Edwin Pogue <trevor.pogue@gmail.com>
 ;; URL: https://github.com/trevorpogue/topspace
 ;; Keywords: convenience, scrolling, center, cursor, margin, padding
-;; Version: 0.2.1
+;; Version: 0.3.0
 ;; Package-Requires: ((emacs "25.1"))
 
-;; This program is free software: you can redistribute it and/or modify
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
 ;; the Free Software Foundation, either version 3 of the License, or
 ;; (at your option) any later version.
 
-;; This program is distributed in the hope that it will be useful,
+;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
 
 ;;; Commentary:
+
 ;; TopSpace allows you to scroll down and recenter top lines
 ;; by automatically drawing an upper margin/padding above the top line
 ;; as you scroll down or recenter top text.
@@ -59,9 +62,6 @@
 
 ;;; Code:
 
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;; Debugging
-
 
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;; Private variables
 
@@ -699,6 +699,9 @@ ARG defaults to 1."
         (beginning-of-visual-line)
         (setq next-line-point (point)))
       (when (and
+             ;; These checks are for improving performance by only running
+             ;; `topspace--count-lines' run by `topspace--total-lines-past-max'
+             ;; when necessary because `topspace--count-lines' is slow
              (>= (point) next-line-point)
              (< (- (line-number-at-pos (point))
                    (line-number-at-pos topspace--pre-command-point))