Remove documents for magithub in the github layer, as it has already been removed.
This commit is contained in:
Hong Xu
duianto
parent
653a38bce5
commit
8485e69fa9
|
|
@ -1428,11 +1428,8 @@ Other:
|
|||
**** GitHub
|
||||
- Packages:
|
||||
- Added new packages =forge= (thanks to Miciah Dashiel Butler Masters)
|
||||
- Added package =magithub=, it is enabled by default in offline mode.
|
||||
- Remove package =github-browse-file= which has been replaced by
|
||||
=browse-at-remote= in =version-control= layer
|
||||
- Remove package =magit-gh-pulls= as it was deprecated in favor of =magithub=
|
||||
and =forge= (thanks to Robby O'Connor)
|
||||
- Key bindings:
|
||||
- Added ~g r~ evilified binding to gist-list-mode
|
||||
(thanks to Jean-Sebastien A. Beaudry)
|
||||
|
|
@ -1444,8 +1441,13 @@ Other:
|
|||
- ~SPC m k~ or ~SPC m k~ cancel post
|
||||
- Replace =evilified-state-evilify= by =evilified-state-evilify-map=
|
||||
(thanks to Sylvain Benner)
|
||||
- Made magithub offline by default (thanks to Miciah Masters)
|
||||
- Disabled status, issues, and PRs by default (thanks to Miciah Masters)
|
||||
- Removed mentions of the removed package =magithub= (thanks to Hong Xu)
|
||||
Obsolete:
|
||||
- Added package =magithub=, it is enabled by default in offline mode.
|
||||
- Remove package =magit-gh-pulls= as it was deprecated in favor of =magithub=
|
||||
and =forge= (thanks to Robby O'Connor)
|
||||
- Made magithub offline by default (thanks to Miciah Masters)
|
||||
**** Git
|
||||
- Install magit-svn by default and activate with git-enable-magit-svn-plugin
|
||||
- Key bindings:
|
||||
|
|
|
|||
|
|
@ -10,10 +10,7 @@
|
|||
- [[#install][Install]]
|
||||
- [[#layer][Layer]]
|
||||
- [[#git-configuration][Git configuration]]
|
||||
- [[#hub-configuration][Hub configuration]]
|
||||
- [[#magithub-configuration][Magithub configuration]]
|
||||
- [[#key-bindings][Key bindings]]
|
||||
- [[#magithub][magithub]]
|
||||
- [[#forge][forge]]
|
||||
- [[#gistel][gist.el]]
|
||||
- [[#clone-repositories][Clone repositories]]
|
||||
|
|
@ -22,7 +19,6 @@
|
|||
This layers adds support for [[http://github.com][GitHub]].
|
||||
|
||||
** Features:
|
||||
- [[https://github.com/vermiculus/magithub][magithub]]: Magit-integrated interface to [[https://hub.github.com/][hub]] command line
|
||||
- [[https://github.com/magit/forge][forge]]: integration with various forges, such as GitHub and GitLab.
|
||||
- [[https://github.com/defunkt/gist.el][gist.el]]: full-featured mode to browse and post GitHub gists.
|
||||
- [[https://github.com/sshaw/git-link][git-link]]: quickly generate URLs for commits or files.
|
||||
|
|
@ -45,49 +41,7 @@ You will also need to [[https://help.github.com/articles/generating-a-new-ssh-ke
|
|||
git config --global github.oauth-token <token>
|
||||
#+END_SRC
|
||||
|
||||
** Hub configuration
|
||||
For now, =Magithub= requires the =hub= utility to work -- before trying to use
|
||||
Magithub, follow the installation instructions at hub.github.com. To force hub
|
||||
to authenticate, you can use hub browse in a terminal (inside a GitHub repo).
|
||||
|
||||
** Magithub configuration
|
||||
Spacemacs configures =Magithub= to be in offline mode by default and disables
|
||||
displaying the GitHub project status, issues, and pull requests because loading
|
||||
project data for repositories with many pull requests or issues can be
|
||||
exorbitantly slow (see [[https://github.com/syl20bnr/spacemacs/issues/11176][issue #11176]]). To toggle online mode and the project
|
||||
status, issues, and pull requests sections for the current repository, open in
|
||||
the =magit status= buffer (~SPC g s~) and then open the Magithub settings popup
|
||||
(~@ C~). To enable online mode and the project status, pull requests, and
|
||||
issues sections by default, use the following shell commands:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
git config --global --bool magithub.online true
|
||||
git config --global --bool magithub.status.includeStatusHeader true
|
||||
git config --global --bool magithub.status.includePullRequestsSection true
|
||||
git config --global --bool magithub.status.includeIssuesSection true
|
||||
#+END_SRC
|
||||
|
||||
Alternatively, use the following Emacs forms:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(magit-set "true" "--global" "magithub.online")
|
||||
(magit-set "true" "--global" "magithub.status.includeStatusHeader")
|
||||
(magit-set "true" "--global" "magithub.status.includePullRequestsSection")
|
||||
(magit-set "true" "--global" "magithub.status.includeIssuesSection")
|
||||
#+END_SRC
|
||||
|
||||
* Key bindings
|
||||
** magithub
|
||||
|
||||
| Key binding | Description |
|
||||
|-------------+--------------------------------------------------|
|
||||
| ~@ C~ | open the Magithub settings popup |
|
||||
| ~@ H~ | opens the current repository in the browser |
|
||||
| ~@ c~ | pushes a brand-new local repository up to GitHub |
|
||||
| ~@ f~ | create a fork of an existing repository |
|
||||
| ~@ p~ | submit pull request upstream |
|
||||
| ~@ i~ | create an issue |
|
||||
|
||||
** forge
|
||||
In a =magit-status= buffer (~SPC g s~):
|
||||
|
||||
|
|
|
|||
|
|
@ -15,11 +15,6 @@
|
|||
gist
|
||||
github-clone
|
||||
github-search
|
||||
;; magithub has been replaced by forge
|
||||
;; The configuration has been commented so you can move it
|
||||
;; to a private layer if you want.
|
||||
;; Commments will be remove in a few weeks
|
||||
;; magithub
|
||||
;; this package does not exits, we need it to wrap
|
||||
;; the call to spacemacs/declare-prefix.
|
||||
(spacemacs-github :location built-in)
|
||||
|
|
@ -83,30 +78,5 @@
|
|||
:commands (github-search-clone-repo github-search-user-clone-repo)
|
||||
:init (spacemacs/set-leader-keys "ghc/" 'github-search-clone-repo)))
|
||||
|
||||
|
||||
;; (defun github/init-magithub ()
|
||||
;; (use-package magithub
|
||||
;; :after magit
|
||||
;; :init
|
||||
;; (setq magithub-dir (concat spacemacs-cache-directory "magithub/"))
|
||||
;; :config
|
||||
;; (progn
|
||||
;; ;; Configure Magithub to be offline by default because loading data from
|
||||
;; ;; projects with many pull requests or issues can be exorbitantly slow.
|
||||
;; ;; See <https://github.com/syl20bnr/spacemacs/issues/11176>.
|
||||
;; (when (null (magit-get "--global" "magithub.online"))
|
||||
;; (magit-set "false" "--global" "magithub.online")
|
||||
;; (magit-set "false" "--global" "magithub.status.includeStatusHeader")
|
||||
;; (magit-set "false" "--global" "magithub.status.includePullRequestsSection")
|
||||
;; (magit-set "false" "--global" "magithub.status.includeIssuesSection"))
|
||||
;; (magithub-feature-autoinject `(,@(when (not (package-installed-p 'forge))
|
||||
;; '(issues-section
|
||||
;; pull-requests-section))
|
||||
;; completion
|
||||
;; status-checks-header
|
||||
;; commit-browse
|
||||
;; pull-request-merge))
|
||||
;; (define-key magit-status-mode-map "@" #'magithub-dispatch-popup))))
|
||||
|
||||
(defun github/init-spacemacs-github ()
|
||||
(spacemacs/declare-prefix "gh" "github"))
|
||||
|
|
|
|||
Loading…
Reference in New Issue