From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C0699A0548; Tue, 27 Apr 2021 11:54:28 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7ED1C4067E; Tue, 27 Apr 2021 11:54:28 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mails.dpdk.org (Postfix) with ESMTP id F338E40150 for ; Tue, 27 Apr 2021 11:54:26 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1619517266; h=from:from: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; bh=h/HsoTFeS5yPi9K3CdEIr0TYb8LmCeLJom1txUsoj5g=; b=RZPBmW9GDrmZqlu+NtiHy+AOTmWQ/eRk/xqIZY6P5GgDqIylCsdUgLInNZBMVBRbIp2CDx qIAwklQ4M/RrXc+FKeIqzyW1sMogzLktZbMkSqJsp3+IS1GGj6HLsdMBysQfNFIfZ/bu+1 6cYn56z96uXYpmD3ldKm1N3im57jh8I= Received: from mail-vs1-f72.google.com (mail-vs1-f72.google.com [209.85.217.72]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-327--6t-ia0QOAiXe3wsubkMsw-1; Tue, 27 Apr 2021 05:54:23 -0400 X-MC-Unique: -6t-ia0QOAiXe3wsubkMsw-1 Received: by mail-vs1-f72.google.com with SMTP id 3-20020a6717030000b029016d08542c7dso12142949vsx.14 for ; Tue, 27 Apr 2021 02:54:23 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=h/HsoTFeS5yPi9K3CdEIr0TYb8LmCeLJom1txUsoj5g=; b=gXTU6ALqkbYLr5bqZ3hCuk2qTpQNLLUb9SScwoHpC2yfP2+u7b5+xBojEgrajdkJml 93CxsTQ7Htz9NpdJ4qUQuD2Wc1GvpBgHyu+mZIEGroVlkG27amrJmADC2mETXAdpmuLO JEbG9ZBk4plHVLUa6a1tpR1YyF8iMUca2t75mXczlxNRD6X5ZUhv1/BFS6x6MTJypo/J pN5AeV6KRQbbrHgCvLm78DBqEykBUhvTmSEA+eT5xld98WjGPOo/JTsqIIkMZyZUXMHK h3ThfRdvri9WVfT5xyAJkIFe4ZqgtyManfgUvycZv+OdrxLZtoaFag/x5c5RYd0V3Sz/ 346Q== X-Gm-Message-State: AOAM530EXj9qJBLr8LoYGGMX8qAjvtcPuJ/c9To9c1JyX91XnBuEYLgf P9VCdbnhC2C57XvfYNljsl7BeUQ5DIFDmUsNVlZb8y918eJwjvdppPRWsSdixFe+GW/1igHYl+r q2LrZ5xa45uZ9WmfYWJw= X-Received: by 2002:a67:fdd8:: with SMTP id l24mr7240578vsq.18.1619517262651; Tue, 27 Apr 2021 02:54:22 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwmSNFSDKX/nh0dRKsh2p27Y6DGB5eDpeDtZS44KDXPi+S2E/Wcav22ffBzpi/5XF3KCSAs+ftgp7LLFypPeOw= X-Received: by 2002:a67:fdd8:: with SMTP id l24mr7240570vsq.18.1619517262423; Tue, 27 Apr 2021 02:54:22 -0700 (PDT) MIME-Version: 1.0 References: <20210421091146.1384708-1-conor.walsh@intel.com> In-Reply-To: <20210421091146.1384708-1-conor.walsh@intel.com> From: David Marchand Date: Tue, 27 Apr 2021 11:54:11 +0200 Message-ID: To: Conor Walsh Cc: "Mcnamara, John" , Thomas Monjalon , "Yigit, Ferruh" , Bruce Richardson , "Burakov, Anatoly" , dev Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=dmarchan@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Subject: Re: [dpdk-dev] [PATCH] doc/contributing/documentation: add info about including code X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On Wed, Apr 21, 2021 at 11:12 AM Conor Walsh wrote: > > Currently the documentation describes how to add code snippets to the > docs using code blocks. This can be problematic as the code snippets > in the docs may fall out of sync with the actual code it is referencing > within DPDK. This patch adds instructions to the contribution guide > about how to include code in the docs using literalinclude which will > dynamically get the code from source when the docs are generated. This > will help to ensure that the code within the docs is up to date and not > out of sync with the actual code. Note: We used literalinclude in the past and there was an issue with pdf: https://git.dpdk.org/dpdk/commit/?id=d3ce1dc637c1bbef9a407f10281b2bc0549256da But we don't generate pdf anymore, so we are good. > > Signed-off-by: Conor Walsh Acked-by: David Marchand -- David Marchand