Cover Detail
Show a cover letter.
GET /api/covers/467/?format=api
{ "id": 467, "url": "http://patches.dpdk.org/api/covers/467/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/cover/20231208021108.2001-1-dave@youngcopy.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20231208021108.2001-1-dave@youngcopy.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231208021108.2001-1-dave@youngcopy.com", "date": "2023-12-08T02:11:07", "name": "[0/1] docs:programmers guide index reflow", "submitter": { "id": 3122, "url": "http://patches.dpdk.org/api/people/3122/?format=api", "name": "Dave Young", "email": "dave@youngcopy.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/cover/20231208021108.2001-1-dave@youngcopy.com/mbox/", "series": [ { "id": 30483, "url": "http://patches.dpdk.org/api/series/30483/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30483", "date": "2023-12-08T02:11:07", "name": "docs:programmers guide index reflow", "version": 1, "mbox": "http://patches.dpdk.org/series/30483/mbox/" } ], "comments": "http://patches.dpdk.org/api/covers/467/comments/", "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 129DB436A0;\n\tFri, 8 Dec 2023 03:11:32 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id EEFBA410FB;\n\tFri, 8 Dec 2023 03:11:31 +0100 (CET)", "from mail-yw1-f176.google.com (mail-yw1-f176.google.com\n [209.85.128.176])\n by mails.dpdk.org (Postfix) with ESMTP id 37754402AC\n for <dev@dpdk.org>; Fri, 8 Dec 2023 03:11:30 +0100 (CET)", "by mail-yw1-f176.google.com with SMTP id\n 00721157ae682-5d63f04779bso2660227b3.1\n for <dev@dpdk.org>; Thu, 07 Dec 2023 18:11:30 -0800 (PST)", "from localhost.localdomain\n ([2600:1700:20c0:a560:d1dd:3efb:9d96:5cfd])\n by smtp.gmail.com with ESMTPSA id\n v4-20020a818504000000b005d9729068f5sm339927ywf.42.2023.12.07.18.11.27\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Thu, 07 Dec 2023 18:11:28 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1702001489;\n x=1702606289;\n darn=dpdk.org;\n h=content-transfer-encoding:mime-version:message-id:date:subject:cc\n :to:from:from:to:cc:subject:date:message-id:reply-to;\n bh=c20hff+IPckyF/vbmB0/BGEXYSKKyXyCcD351Yes3sk=;\n b=xuxlrDqRKd0A0hC+fBJBLHdkzrWTuP8Wr9W9THJhgzvLOIWDisZ7Suz10eYwxSFkDW\n 371tjDYHT/ydjQqhcb2f5jJRVskvfocBHAtD1fYyjY/1M3+DsMgod9ajrvfh/Ynlgh79\n pTsHMRwm+cCA78O4q8v71utG1cys49zy3QRoGam62RXzlbnp4w+BxHSgqmIVG9lYtM89\n DSH13EwsZbtekFxtqH19AayLyCP1Yxq0PidUTpf54uEa5esyRQY67vTrMdVJ3VeLVCuh\n preKvI+iR7ebQuigARmxaafcRi2/gmENvDUxkAs2Q8Rf8f0oLQznGcxpomZiJGzDUTLd\n 66aw==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1702001489; x=1702606289;\n h=content-transfer-encoding:mime-version:message-id:date:subject:cc\n :to:from:x-gm-message-state:from:to:cc:subject:date:message-id\n :reply-to;\n bh=c20hff+IPckyF/vbmB0/BGEXYSKKyXyCcD351Yes3sk=;\n b=q++wfkXGACcHk4uRS/y7JBUBs66l44Hnl8X+tvQ1oL3lmzV0P6fTJixHCKgd1nJb1P\n gd0ZcRIKkT3+/wV6KWS/hYAQAagPZq6FTYZe+HAM38DRzcky//Cck8C6bruiHDkXfNgu\n 5a2RwJJ04H/3eTw+HkKW1Pyt8Ro4meORPLnR86zuKKVv9MIujC41znRIkG439sbp7JLO\n e4hkhAeIBi9JP/jYc1Vugs+H6lG1CTpR7AoAfIsyqJNSQJ8MwUN4vx+yLghTKR241m7W\n yzXlnZtN27uyuTPgLih+ChjJje7IRG+ACWfsFsDULDGQcBGMm0JV1O1pIilKZ/IUwB89\n KbhA==", "X-Gm-Message-State": "AOJu0YzGPfQYyFMzEhteI2prCEGiae6vgeeZkSkMOhbmqJcdthrkkxA5\n KEiRVPWNBLVcDwckD3SF8IfwdRK8/Yi7SvlOHF8=", "X-Google-Smtp-Source": "\n AGHT+IEEWEKEuAlPXqoYq29l4Z/BNE4Q54ji3lj8GRd+EKYK9qgN39NLUOV/Rwc60sDI4RoUaZhgdQ==", "X-Received": "by 2002:a0d:cbce:0:b0:5d4:3013:25d6 with SMTP id\n n197-20020a0dcbce000000b005d4301325d6mr5324149ywd.5.1702001488813;\n Thu, 07 Dec 2023 18:11:28 -0800 (PST)", "From": "David Young <dave@youngcopy.com>", "To": "dev@dpdk.org", "Cc": "Bruce Richardson <bruce.richardson@intel.com>,\n Thomas Monjalon <thomas@monjalon.net>, David Young <dave@youngcopy.com>", "Subject": "[PATCH 0/1] docs:programmers guide index reflow", "Date": "Thu, 7 Dec 2023 21:11:07 -0500", "Message-ID": "<20231208021108.2001-1-dave@youngcopy.com>", "X-Mailer": "git-send-email 2.41.0.windows.1", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Enhanced Organization of the Programmer's Guide for Better Clarity\n\n- Restructured main sections for coherent topic grouping; added 'Foundation Principles',\n 'Memory Management', 'CPU Management', and 'Device Libraries'.\n- 'Foundation Principles' now includes 'Introduction', 'Overview', 'Source Organization',\n and a new 'Glossary' section.\n- Consolidated memory-related topics under 'Memory Management', enhancing topic discoverability.\n- Introduced 'CPU Management' to centralize CPU-related libraries and features.\n- Reorganized 'Device Libraries' for clearer categorization of device-specific documentation.\n- Grouped packet processing topics under 'CPU Packet Processing' for focused guidance.\n- 'Utility Libraries' section newly created to encompass supporting libraries like Timer,\n RCU, and Ring libraries.\n- Refined 'Protocol Processing Libraries' section, emphasizing protocol-specific information.\n- New 'High-Level Libraries' section highlights advanced libraries like Packet Framework and\n Graph Library.\n- Added 'Howto Guides' and 'Tips & Tricks' for practical, hands-on advice and optimization\n techniques.\n- Updated filenames and page titles for consistency and clarity, including the addition\n of 'library' in titles where it was previously missing.\n- This reorganization simplifies guide navigation, facilitating quicker access to information.\n\nDavid Young (1):\n Modified Programmer's Guide index for better organization and\n readability\n\n doc/guides/prog_guide/bpf_lib.rst | 4 +-\n doc/guides/prog_guide/dmadev.rst | 6 +-\n doc/guides/prog_guide/efd_lib.rst | 4 +-\n .../prog_guide/env_abstraction_layer.rst | 4 +-\n doc/guides/prog_guide/ethdev/index.rst | 12 ++\n .../prog_guide/{ => ethdev}/poll_mode_drv.rst | 0\n .../prog_guide/{ => ethdev}/qos_framework.rst | 0\n .../prog_guide/{ => ethdev}/rte_flow.rst | 0\n .../{ => ethdev}/switch_representation.rst | 0\n .../{ => ethdev}/traffic_management.rst | 0\n .../traffic_metering_and_policing.rst | 0\n .../{ => eventdev}/event_crypto_adapter.rst | 0\n .../event_ethernet_rx_adapter.rst | 0\n .../event_ethernet_tx_adapter.rst | 0\n .../{ => eventdev}/event_timer_adapter.rst | 0\n .../prog_guide/{ => eventdev}/eventdev.rst | 2 +-\n doc/guides/prog_guide/eventdev/index.rst | 11 ++\n doc/guides/prog_guide/fib_lib.rst | 4 +-\n .../generic_receive_offload_lib.rst | 4 +-\n .../generic_segmentation_offload_lib.rst | 4 +-\n doc/guides/prog_guide/gpudev.rst | 4 +-\n doc/guides/prog_guide/index.rst | 145 ++++++++++++------\n doc/guides/prog_guide/lpm6_lib.rst | 4 +-\n doc/guides/prog_guide/lpm_lib.rst | 4 +-\n doc/guides/prog_guide/mbuf_lib.rst | 6 +-\n doc/guides/prog_guide/mempool_lib.rst | 4 +-\n doc/guides/prog_guide/mldev.rst | 6 +-\n .../prog_guide/packet_classif_access_ctrl.rst | 4 +-\n doc/guides/prog_guide/packet_framework.rst | 4 +-\n doc/guides/prog_guide/rawdev.rst | 4 +-\n doc/guides/prog_guide/regexdev.rst | 4 +-\n doc/guides/prog_guide/rib_lib.rst | 4 +-\n ...y_dpdk_functions.rst => thread_safety.rst} | 4 +-\n 33 files changed, 166 insertions(+), 86 deletions(-)\n create mode 100644 doc/guides/prog_guide/ethdev/index.rst\n rename doc/guides/prog_guide/{ => ethdev}/poll_mode_drv.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/qos_framework.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/rte_flow.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/switch_representation.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/traffic_management.rst (100%)\n rename doc/guides/prog_guide/{ => ethdev}/traffic_metering_and_policing.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_crypto_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_rx_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_ethernet_tx_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/event_timer_adapter.rst (100%)\n rename doc/guides/prog_guide/{ => eventdev}/eventdev.rst (99%)\n create mode 100644 doc/guides/prog_guide/eventdev/index.rst\n rename doc/guides/prog_guide/{thread_safety_dpdk_functions.rst => thread_safety.rst} (98%)" }