branch: externals/org
commit 33bf89f2da68b1e634e58e90028a954947e1a43f
Author: Ihor Radchenko <[email protected]>
Commit: Ihor Radchenko <[email protected]>
doc/org-manual.org: Document caveat about :comments link
* doc/org-manual.org (Header arguments): Recommend
`org-id-link-to-org-use-id' when using :comments link.
---
doc/org-manual.org | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 5c179015ef..fe2cd171e1 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -19619,6 +19619,14 @@ already exist in the code block.
Wrap the code block in comments. Include links pointing back to the
place in the Org file from where the code was tangled.
+ #+findex: org-store-link
+ #+vindex: org-id-link-to-org-use-id
+ Do note that Org will use ~org-store-link~ ([[*Handling Links]]) to
+ store link to code block. Such link may not be unique if the parent
+ heading title is a duplicate of earlier heading or changes after
+ tangling. We recommend setting ~org-id-link-to-org-use-id~ to t to
+ make sure that the link points to the correct heading.
+
- =yes= ::
Kept for backward compatibility; same as =link=.
