From 7cd7b90dcb7ef87f1eb63d93ab725407e92f9979 Mon Sep 17 00:00:00 2001 From: Kaushal Modi Date: Fri, 9 Jun 2017 15:28:49 -0400 Subject: [PATCH] Update remote file syntax for Tramp * testing/lisp/test-ox.el (test-org-export/file-uri): * doc/org.texi (External links): The method part of remote file names is mandatory now in the emacs master (26+). A valid remote file name starts with "/method:host:" or "/method:user@host:". ssh is used as an example method here. This change in the examples is backward compatible with emacs 25, 24, .. Suggested by: Michael Albinus Relevant commit in emacs master causing this change: --- doc/org.texi | 80 ++++++++++++++++++++--------------------- testing/lisp/test-ox.el | 4 +-- 2 files changed, 42 insertions(+), 42 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index c50e44c3a..93a4b2e48 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -3531,44 +3531,44 @@ string followed by a colon. There can be no space after the colon. The following list shows examples for each link type. @example -http://www.astro.uva.nl/~dominik @r{on the web} -doi:10.1000/182 @r{DOI for an electronic resource} -file:/home/dominik/images/jupiter.jpg @r{file, absolute path} -/home/dominik/images/jupiter.jpg @r{same as above} -file:papers/last.pdf @r{file, relative path} -./papers/last.pdf @r{same as above} -file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine} -/myself@@some.where:papers/last.pdf @r{same as above} -file:sometextfile::NNN @r{file, jump to line number} -file:projects.org @r{another Org file} -file:projects.org::some words @r{text search in Org file}@footnote{ +http://www.astro.uva.nl/~dominik @r{on the web} +doi:10.1000/182 @r{DOI for an electronic resource} +file:/home/dominik/images/jupiter.jpg @r{file, absolute path} +/home/dominik/images/jupiter.jpg @r{same as above} +file:papers/last.pdf @r{file, relative path} +./papers/last.pdf @r{same as above} +file:/ssh:myself@@some.where:papers/last.pdf @r{file, path on remote machine} +/ssh:myself@@some.where:papers/last.pdf @r{same as above} +file:sometextfile::NNN @r{file, jump to line number} +file:projects.org @r{another Org file} +file:projects.org::some words @r{text search in Org file}@footnote{ The actual behavior of the search will depend on the value of the option @code{org-link-search-must-match-exact-headline}. If its value -is @code{nil}, then a fuzzy text search will be done. If it is t, then only the -exact headline will be matched, ignoring spaces and cookies. If the value is -@code{query-to-create}, then an exact headline will be searched; if it is not -found, then the user will be queried to create it.} -file:projects.org::*task title @r{heading search in Org -file}@footnote{Headline searches always match the exact headline, ignoring +is @code{nil}, then a fuzzy text search will be done. If it is t, then only +the exact headline will be matched, ignoring spaces and cookies. If the +value is @code{query-to-create}, then an exact headline will be searched; if +it is not found, then the user will be queried to create it.} +file:projects.org::*task title @r{heading search in Org file}@footnote{ +Headline searches always match the exact headline, ignoring spaces and cookies. If the headline is not found and the value of the option @code{org-link-search-must-match-exact-headline} is @code{query-to-create}, then the user will be queried to create it.} -docview:papers/last.pdf::NNN @r{open in doc-view mode at page} -id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} -news:comp.emacs @r{Usenet link} -mailto:adent@@galaxy.net @r{Mail link} -mhe:folder @r{MH-E folder link} -mhe:folder#id @r{MH-E message link} -rmail:folder @r{RMAIL folder link} -rmail:folder#id @r{RMAIL message link} -gnus:group @r{Gnus group link} -gnus:group#id @r{Gnus article link} -bbdb:R.*Stallman @r{BBDB link (with regexp)} -irc:/irc.com/#emacs/bob @r{IRC link} -info:org#External links @r{Info node or index link} -shell:ls *.org @r{A shell command} -elisp:org-agenda @r{Interactive Elisp command} -elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} +docview:papers/last.pdf::NNN @r{open in doc-view mode at page} +id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} +news:comp.emacs @r{Usenet link} +mailto:adent@@galaxy.net @r{Mail link} +mhe:folder @r{MH-E folder link} +mhe:folder#id @r{MH-E message link} +rmail:folder @r{RMAIL folder link} +rmail:folder#id @r{RMAIL message link} +gnus:group @r{Gnus group link} +gnus:group#id @r{Gnus article link} +bbdb:R.*Stallman @r{BBDB link (with regexp)} +irc:/irc.com/#emacs/bob @r{IRC link} +info:org#External links @r{Info node or index link} +shell:ls *.org @r{A shell command} +elisp:org-agenda @r{Interactive Elisp command} +elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} @end example @cindex VM links @@ -3579,13 +3579,13 @@ to VM or Wanderlust messages are available when you load the corresponding libraries from the @code{contrib/} directory: @example -vm:folder @r{VM folder link} -vm:folder#id @r{VM message link} -vm://myself@@some.where.org/folder#id @r{VM on remote machine} -vm-imap:account:folder @r{VM IMAP folder link} -vm-imap:account:folder#id @r{VM IMAP message link} -wl:folder @r{WANDERLUST folder link} -wl:folder#id @r{WANDERLUST message link} +vm:folder @r{VM folder link} +vm:folder#id @r{VM message link} +vm://myself@@some.where.org/folder#id @r{VM on remote machine} +vm-imap:account:folder @r{VM IMAP folder link} +vm-imap:account:folder#id @r{VM IMAP message link} +wl:folder @r{WANDERLUST folder link} +wl:folder#id @r{WANDERLUST message link} @end example For customizing Org to add new link types @ref{Adding hyperlink types}. diff --git a/testing/lisp/test-ox.el b/testing/lisp/test-ox.el index d69660178..f55cdd4fe 100644 --- a/testing/lisp/test-ox.el +++ b/testing/lisp/test-ox.el @@ -3252,8 +3252,8 @@ Another text. (ref:text) (should (equal (concat (if (memq system-type '(windows-nt cygwin)) "file:///" "file://") (expand-file-name "/local.org")) (org-export-file-uri "/local.org"))) ;; Remote files start with "file://" - (should (equal "file://myself@some.where:papers/last.pdf" - (org-export-file-uri "/myself@some.where:papers/last.pdf"))) + (should (equal "file://ssh:myself@some.where:papers/last.pdf" + (org-export-file-uri "/ssh:myself@some.where:papers/last.pdf"))) (should (equal "file://localhost/etc/fstab" (org-export-file-uri "//localhost/etc/fstab"))) ;; Expand filename starting with "~".