Skip to content

pr update use package declaration use it in documentation - #1059

Draft
matsl wants to merge 6 commits into
masterfrom
pr_update-use-package-declaration-use-it-in-documentation
Draft

matsl wants to merge 6 commits into
masterfrom
pr_update-use-package-declaration-use-it-in-documentation

Conversation

@matsl

@matsl matsl commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

What

Update the use-package declaration and use it in the documentation.

  • Handle no debug exit gracefully with no error
  • Update use-package declaration
  • Use use-package declaration in documentation

Why

Refactoring the use-package declaration based on feedback from users.

Note

This is a draft PR since the documentation is not updated. That will
be rearranged so that installation and configuration are more
separated.

Installation section will be made shorter to not go into details on
the different package managers. It should suffice to mention what
archives to set the package-archives to or what url the repository is
at more or less.

For the configuration the use-package declaration will be used.

@rswgnu

rswgnu commented Sep 17, 2026

Copy link
Copy Markdown
Owner

Looks reasonable assuming tested successfully.

@rswgnu rswgnu left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rebase off master and the trailing whitespace changes should disappear so we can consider further changes without those. Also, see inline comments.

Comment thread man/hyperbole.texi
There are multiple package managers you can use to install Hyperbole once
you have GNU Emacs set up at your site. Choose one based on your needs.
Hyperbole can be installed using Emacs' package manager, from its
development repository or manually from the tarball archive.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The above change looks like a regression to me.

@matsl matsl Sep 23, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I understand that. I want to put less emphasis on choosing a packet manager. and more focus on that the user already has an Emacs capable of installing Hyperbole. So lowering the bar so to speak. Users who already use other package managers will not be confused by this. Or what do you think?

Comment thread man/hyperbole.texi
@noindent
MELPA Snapshots:

Now save the file and restart Emacs. Hyperbole will then be downloaded

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Snapshots is equiv to elpa-devel so it should come first and melpa releases should be in the stable release section.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that is a bit confusing. I want ELPA to be the users first choice. What do you think of moving info about MELPA to a paragraph telling that it is possible to use MELPA as well if user prefers that. And by that skip the bullet-list removing the mix of stable(release) and devel(snapshot) since that can be confusing?

Comment thread man/hyperbole.texi
For installing from GNU-devel ELPA, MELPA releases or MELPA snapshots
add the respective archive to package-archives in your init
file, see @pxref{Init File,,The Emacs Initialization File,emacs, the GNU Emacs
Manual}.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's discuss this rewrite.

Comment thread man/use-package Outdated
Comment thread man/use-package Outdated
* install-test/install-test.sh: Avoid debug check setting the exit status.
* man/use-package (hyperbole): Simplify by removing conditional
activation of hyperbole-mode and hywiki-mode.  Bind keys in
hyperbole-mode-map.  Advice how the default hyperbole-menu global
activation keys can be changed.
* man/hy-package.el:
* man/hy-straight.el: Deleted, prefer use-package declaration.

* man/hyperbole.texi (Elpa Latest or Release Package Installation):
(Git Latest Package Installation): Use verbatiminclude to avoid
Texinfo interpreting { } chars in use-package.
The configuration section is inserted after the install
instructions. Both constitute an Install and Configuration node.

The install instructions have thus been changed to work with that
organization and have been simplified. The simplification is both
removing text and to refer to the package managers documentation
rather than to provide running examples.

A lot of whitespace at the end of lines have been removed due to me
forgetting to turn off delete-trailing-whitespace-mode.
@matsl
matsl force-pushed the pr_update-use-package-declaration-use-it-in-documentation branch from 320dc51 to 1070203 Compare September 23, 2026 22:01
@matsl
matsl requested a review from rswgnu September 23, 2026 22:05
@matsl

matsl commented Sep 23, 2026

Copy link
Copy Markdown
Collaborator Author

@rswgnu I have rebased so you don't have to configure github to ignore whitespace, changed the use-package to avoid hanging parens and added some comments to the PR for the discussion.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants