emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: John Hendy <jw.hendy@gmail.com>
To: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: [PATCH] Change to org-src-preserve-indentation documentation
Date: Sun, 2 Feb 2014 10:06:10 -0600	[thread overview]
Message-ID: <CA+M2ft_Yk99Joyq=9Ytc1cPw-5zTROf5iRz4XS_Z1+XeFvWqcw@mail.gmail.com> (raw)

[-- 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


             reply	other threads:[~2014-02-02 16:10 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-02-02 16:06 John Hendy [this message]
2014-02-02 21:35 ` [PATCH] Change to org-src-preserve-indentation documentation 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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CA+M2ft_Yk99Joyq=9Ytc1cPw-5zTROf5iRz4XS_Z1+XeFvWqcw@mail.gmail.com' \
    --to=jw.hendy@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).