emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [PATCH] Change to org-src-preserve-indentation documentation
@ 2014-02-02 16:06 John Hendy
  2014-02-02 21:35 ` Nicolas Goaziou
  0 siblings, 1 reply; 6+ messages in thread
From: John Hendy @ 2014-02-02 16:06 UTC (permalink / raw)
  To: emacs-orgmode

[-- Attachment #1: Type: text/plain, Size: 888 bytes --]

Greetings,


Per some other discussions on the mentioned variable, I added a bit
more information to org.texi to help other users find it's
documentation in the manual.

Old description:
This variable is especially useful for tangling languages such as
Python, in which whitespace indentation in the output is critical.

New description:
By default, the value is nil, which means that whitespace characters will be
collapsed upon exporting/tangling, according to the value of
org-edit-src-content-indentation.
If set to t, code blocks will be exported/tangled with whitespace
preserved, exactly as they
appear in the org buffer. This variable is especially useful for
tangling languages such as
Python, in which whitespace indentation in the output is critical.

Let me know if I should change anything; happy to adjust to a better
explanation and re-create a patch.


Best regards,
John

[-- Attachment #2: 0001-Update-org.texi-documentation-for-org-src-preserve-i.patch --]
[-- Type: text/x-patch, Size: 1317 bytes --]

From e2710a3d5b620152ea7ab81489cc20cf23747b16 Mon Sep 17 00:00:00 2001
From: John Henderson <jw.hendy@gmail.com>
Date: Fri, 31 Jan 2014 15:29:47 -0600
Subject: [PATCH] Update org.texi documentation for
 org-src-preserve-indentation

---
 doc/org.texi | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/doc/org.texi b/doc/org.texi
index 9c7a6a7..666282c 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -13798,7 +13798,11 @@ can be used to map arbitrary language names to existing major modes.
 @item org-src-window-setup
 Controls the way Emacs windows are rearranged when the edit buffer is created.
 @item org-src-preserve-indentation
-This variable is especially useful for tangling languages such as
+By default, the value is @code{nil}, which means that whitespace characters will be
+collapsed upon exporting/tangling, according to the value of
+@code{org-edit-src-content-indentation}. If set to @code{t}, code
+blocks will be exported/tangled with whitespace preserved, exactly as they
+appear in the org buffer. This variable is especially useful for tangling languages such as
 Python, in which whitespace indentation in the output is critical.
 @item org-src-ask-before-returning-to-edit-buffer
 By default, Org will ask before returning to an open edit buffer.  Set this
-- 
1.8.5.3


^ permalink raw reply related	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2014-03-12  8:00 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-02-02 16:06 [PATCH] Change to org-src-preserve-indentation documentation John Hendy
2014-02-02 21:35 ` Nicolas Goaziou
2014-02-03 23:12   ` John Hendy
2014-02-04  8:26     ` Sebastien Vauban
2014-03-12  1:26   ` John Hendy
2014-03-12  8:01     ` Nicolas Goaziou

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).