From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id +GAkN0++iF+kVgAA0tVLHw (envelope-from ) for ; Thu, 15 Oct 2020 21:25:35 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id qEjhMk++iF96SAAAbx9fmQ (envelope-from ) for ; Thu, 15 Oct 2020 21:25:35 +0000 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 26DCC9404C5 for ; Thu, 15 Oct 2020 21:25:35 +0000 (UTC) Received: from localhost ([::1]:38214 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kTAke-0001Ea-I6 for larch@yhetil.org; Thu, 15 Oct 2020 17:25:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46016) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kTAhW-0007qH-Hp for emacs-orgmode@gnu.org; Thu, 15 Oct 2020 17:22:19 -0400 Received: from mail-pj1-x1043.google.com ([2607:f8b0:4864:20::1043]:38516) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kTAhR-0001ZD-6q for emacs-orgmode@gnu.org; Thu, 15 Oct 2020 17:22:18 -0400 Received: by mail-pj1-x1043.google.com with SMTP id u3so173023pjr.3 for ; Thu, 15 Oct 2020 14:22:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:subject:in-reply-to:message-id:date :mime-version; bh=nvG1OhnCsNOuDjNWHACIHD4QYQE+iMHBuPQJ+4xWl1M=; b=O7I5YQXGjG1H4NSPfo1CZvGIclfm73Wl9yWL0s3352UpDw8DEx0Aq53UinABLsjsmo Z8HQEZx/JPURLYMiPiVe1ZSd/A2KGlSeryUVhjD+Y683tQRh3bisvv6YbSS0IfEXgJal bJnup0PWNiTwfERrwSVHss4+5iv7Qic3csrI6+t8gqKwodqD4ZHhJWXvG3K53eOf9ufi ux4+k+epkZzL8+FuX6r9PmeRSfgAgtlreximTy2yRCYGVmpPpHr2lUQGWcNjn7P2cjdY dAPIFgCSGHcQKmTR1c8S+k9r1E434n6AcaYvS9Iz+I5odHXDXSFcgKcdrHSwcHooXBNT Bu8A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:subject :in-reply-to:message-id:date:mime-version; bh=nvG1OhnCsNOuDjNWHACIHD4QYQE+iMHBuPQJ+4xWl1M=; b=BM3a/zmt2LoH1O8Qlj4pqgMVAbtQh25NVu3/Puyk0n1tnyjbR7TLinOuZzxwQYgVFP ofJywRgIRYWymKwnDVlGDhU0g1kCqQzmqsqWlr8ed0mDKdZYTYmgR67bR6rcekRDwygz BK/yl4TWfz66pyEAPcIrJiYJB0zYkpez4k9KUJ69Fg0OzNt8JKKSVDJXM5pv2BnvwXe9 4R4oMK1qeLK4R2Qck8tSZCddNhqp7xoZKQt8D38LTAFzh42UIsfDrNB5wSEqJDyyrlep Dg7+y9q2SL9M4F6xqHtF1DOdeRcqL99b585nmjNCyZf+eN7ha2v5h8fxrVZdLNhIJp50 Q9Hg== X-Gm-Message-State: AOAM532vYoaNmfWS3Mrp9g9icygQFjGB31lIHkP4W1pYWIdhZuMyshO3 AbuqMxtPZQlB6dKBiJ/+rwtXy989UqUpDw== X-Google-Smtp-Source: ABdhPJyVHL78dI/vmUIIo2DzjePduF6Dshb0pVMG1w/9za7Um8FNKEqApKNB2OM5NNhtELWRITePZw== X-Received: by 2002:a17:902:8a97:b029:d4:d3f4:d209 with SMTP id p23-20020a1709028a97b02900d4d3f4d209mr646220plo.35.1602796930619; Thu, 15 Oct 2020 14:22:10 -0700 (PDT) Received: from tim-desktop (106-69-139-102.dyn.iinet.net.au. [106.69.139.102]) by smtp.gmail.com with ESMTPSA id f4sm255553pjs.8.2020.10.15.14.22.08 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 15 Oct 2020 14:22:09 -0700 (PDT) References: <1695924.1602785484@apollo2.minshall.org> User-agent: mu4e 1.5.5; emacs 27.1.50 From: Tim Cross To: emacs-orgmode@gnu.org Subject: Re: best practices query: non-emacs packages based on tangled source In-reply-to: <1695924.1602785484@apollo2.minshall.org> Message-ID: <871rhzmbgi.fsf@gmail.com> Date: Fri, 16 Oct 2020 08:22:05 +1100 MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=2607:f8b0:4864:20::1043; envelope-from=theophilusx@gmail.com; helo=mail-pj1-x1043.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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.23 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" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20161025 header.b=O7I5YQXG; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Spam-Score: -1.71 X-TUID: bbGaekBcMbg+ There is no great answer I am aware of. However, I will sometimes generate a markdown version of the source so that at least non-emacs users have a slightly better chance of being able to view the source in a more format friendly manner than a 'raw' org file. However, pull requests and the like are more likely going to be diffs on the generated sources as most people will want to use their preferred editor and that will likely need the generated source file is in order to get their editor 'IDE' features etc. This is one reason I tend not to use org's 'literate programming' model for anything other than documentation, simple examples, configuration files, sql and basic scripting. I find for more complex development, especially when it requires multiple files, namespaces/modules, long running repl sessions, extensive test suits etc, using org adds another layer of complexity which soon outstrips the benefits of having documentation and source in one file. Of course, this will also depend on the development language/platform. I tend to use languages which involve a fair bit of 'REPL' based development rather than a more traditional write, generate, compile, debug loop. On the other hand, when it comes to documentation, tutorials, configuration files and workflow automation, org is definitely my preferred tool. Tim Greg Minshall writes: > hi. i apologize if this has been asked before (especially if by me). > but, since i had a question recently about Org Src... buffers, this came > up. > > i'm wondering what people do who want to release a non-emacs'y package > (an R package, say, or ...), and who did their development "from within" > a .org file. > > i can "build" whatever files are needed to release the package. but, > it's nice to be able to let people look at the sources, maybe submit > 'pull requests', etc. > > if anyone has any techniques they've used, liked (or hated), i'd love to > hear. > > thank you very much, Greg -- Tim Cross