From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id iBgMK4aFfGNYoAAAbAwnHQ (envelope-from ) for ; Tue, 22 Nov 2022 09:17:10 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id YJHyKoaFfGOYwgAAauVa8A (envelope-from ) for ; Tue, 22 Nov 2022 09:17:10 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 399D5105BF for ; Tue, 22 Nov 2022 09:17:10 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oxOS3-0003Su-Bz; Tue, 22 Nov 2022 03:16:23 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oxORt-0003Pv-Rh for emacs-orgmode@gnu.org; Tue, 22 Nov 2022 03:16:11 -0500 Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oxORo-0003V9-Mi for emacs-orgmode@gnu.org; Tue, 22 Nov 2022 03:16:09 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 89A30240026 for ; Tue, 22 Nov 2022 09:15:50 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1669104951; bh=KfVIklMZ6FdfUuzX3ECR0b6oz4H5L0F+dw9bY4j3MWM=; h=From:To:Cc:Subject:Date:From; b=btcQQp3rjdfvt0uh2V432i+wxUKxX9tIrUU/Cyqhsa8gwiPBBrNaUz2O0LDQwmGq7 I00BD2dAkZlGGHBlI9tjtfqLXVa4wIO42KUqR1e5QDsNu7CPeKVsdS7Z8KY2/uKYpN xWaUZJA3blmFxkQaqpTZrfKENRJMcHHHdogvVaQZVY1cbxG0uSHgnztIJVu7+JAa5r cfB0ZgfzMNJ2J49CAZ1HM6Y8/b2gJx/JdQjutJdgt2GUmu6ZByeloo+J7CF4QeW6ec E4sZ8Bmzl03p8CWoK8RDmOzwH2x1LeYDk2Gjz1Ei6AB4WtwojBWHVCAYdjYtIo7tr6 to9Tb7xRQ8Ubg== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4NGcX51HjFz9rxH; Tue, 22 Nov 2022 09:15:48 +0100 (CET) From: Ihor Radchenko To: alain.cochard@unistra.fr Cc: Org Mode List Subject: Re: 2 'echo' bash instructions produce a table In-Reply-To: <25461.4423.734070.149776@gargle.gargle.HOWL> References: <25447.23346.575598.420558@gargle.gargle.HOWL> <87tu3ba40w.fsf@localhost> <25457.22124.839301.412560@gargle.gargle.HOWL> <87pmdqfao4.fsf@localhost> <25461.4423.734070.149776@gargle.gargle.HOWL> Date: Tue, 22 Nov 2022 08:16:31 +0000 Message-ID: <87wn7nieu8.fsf@localhost> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1669105030; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=o1X82GvTFM+fDvst/lNxwGLseGU8K/8UyvqZC5V20q4=; b=N0fl6CIID1X1xXfcSK+4FkTmFbfUX9mj2cS7D4EUBAxBjXxIYjPKPUddgfz2fG2Zyr4Th3 7zX3TxwprZFSrA63eVfdM5vh3ZKqhVMXgr+2C6B02AVaVGY0DdYHKEg6iDmy8FliOA0vXM U+AgNByI7J+4pPW+s90CJKQeokS8IlrXewCJF9W9MNSaRd0VNpP2onOC1CWyEXjMnKcI/E Fc4AL/FCiuy2gQe6t8zb1+T/o3GtTN62RlsG1YBv9q9OmgZPk8Fv/PwARSNBZlwSV64V8z C/fIQpzQZOkhnHDD86smdGOx+/7DGLdA19c/f6a3zEUSdbDl5J8fidKVqiQeJw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1669105030; a=rsa-sha256; cv=none; b=s+5Tq8mou+mTpGXBOexBej+4ctrGopS4pt43cY3+d1yPgLpljJKMeXPMmP/qpb/QUyq4Ng Ab4y9Zr3lkQ3tckAeQVP27QozfqB6asZ6Iq1pXHNY8rVLT8MQZwUdwUK6VEKo+kvojf4tg bB4mnC2YNMGP8/hNAysXd2eIoncYDpSATOkErfcvEIevYEkbPFxdAz+W4l00AosNead533 VwZf12lPR3vZPetjzPRxMwaTAb5yBjgkJlS+k5WSkXdrCDA0dE2I2wcOB1d447yGhnP9iI Swa+3II/xXsdya+0JcM/kllqckTeQTbVn04gV/wdpkplVXJodti0Ni9RKIFpuA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=btcQQp3r; dmarc=pass (policy=none) header.from=posteo.net; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -4.21 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=btcQQp3r; dmarc=pass (policy=none) header.from=posteo.net; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 399D5105BF X-Spam-Score: -4.21 X-Migadu-Scanner: scn0.migadu.com X-TUID: vnWHHNiK/zR7 --=-=-= Content-Type: text/plain Alain.Cochard@unistra.fr writes: > > Will it help if we mention this fact in "16.6 Results of Evaluation" > > section? > > Yes, it would help me. At least I would been warned. But it would be > complete only if knew where to read about each specific babel backend. > > > > For the sake of newcomers, it seems to me that something along the > > > line of what you write above would fit somewhere in 16.6, with a first > > > short mention/warning (and reference to it) next to that excerpt in > > > 16.5: > > > > > > Org captures the results of the code block evaluation and inserts > > > them in the Org file, right after the code block. > > > Talking about ob-shell does not belong to this section of the > > manual. Other backends have different behaviour. Have you seen > > examples in > > https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-shell.html > > ? Are they not clear enough? > > No, I had not seen this before. If I had, I might have understood why > I was getting the "strange" output that originated this thread -- but > I do not find it explained as clearly as you explained it: > > "In the case of two commands returning output, the guess is > yielding the table. In the case of a single command, the guess is > yielding a single string output." > > I can now see that the ob-doc-shell.html page is (indirectly) referred > to in 16.9, via > https://orgmode.org/worg/org-contrib/babel/languages/index.html. > Maybe this is enough for some, but for me it is too convoluted. I had > seen this page, but it was a long time ago, when I checked whether the > languages I use were supported or not. So why not also refer to it in > 16.6, together with the mentioned fact to which you are referring > above? See the attached patch with tentative changes to the manual. Let me know if you think that things are still not clear. --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-org-manual-Clarify-auto-detection-of-code-block-resu.patch >From 015dcb2837089fed8040553d35757818013d991f Mon Sep 17 00:00:00 2001 Message-Id: <015dcb2837089fed8040553d35757818013d991f.1669104972.git.yantar92@posteo.net> From: Ihor Radchenko Date: Tue, 22 Nov 2022 16:13:31 +0800 Subject: [PATCH] org-manual: Clarify auto-detection of code block result type * doc/org-manual.org (How to evaluate source code): Link to Results of evaluation section for details about the inserted code block result. (Type): Clarify that auto-detecting result type relies on specific language backend, linking to the relevant manual section. (Languages): Clarify that Worg is a website. Reported-by: Alain.Cochard@unistra.fr Link: https://orgmode.org/list/25461.4423.734070.149776@gargle.gargle.HOWL --- doc/org-manual.org | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index 70d1c01a3..f395a0986 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -18002,7 +18002,8 @@ *** How to evaluate source code Org captures the results of the code block evaluation and inserts them in the Org file, right after the code block. The insertion point is after a newline and the =RESULTS= keyword. Org creates the =RESULTS= -keyword if one is not already there. +keyword if one is not already there. More details in [[*Results of +Evaluation]]. By default, Org enables only Emacs Lisp code blocks for execution. See [[*Languages]] to enable other languages. @@ -18257,8 +18258,11 @@ *** Type :END: Type tells what result types to expect from the execution of the code -block. Choose one of the options; they are mutually exclusive. The -default behavior is to automatically determine the result type. +block. Choose one of the options; they are mutually exclusive. + +The default behavior is to automatically determine the result type. +The result type detection depends on the code block language, as +described in the documentation for individual [[*Languages][languages]]. #+attr_texinfo: :sep , - =table=, =vector= :: @@ -18865,8 +18869,8 @@ ** Languages #+cindex: source code, languages #+cindex: code block, languages -Code blocks in dozens of languages are supported. See Worg for -[[https://orgmode.org/worg/org-contrib/babel/languages/index.html][language specific documentation]]. +Code blocks in dozens of languages are supported. See Worg website +for [[https://orgmode.org/worg/org-contrib/babel/languages/index.html][language specific documentation]]. #+vindex: org-babel-load-languages By default, only Emacs Lisp is enabled for evaluation. To enable or -- 2.35.1 --=-=-= Content-Type: text/plain -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at --=-=-=--