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 180234579F; Mon, 12 Aug 2024 10:08:18 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DC6D84014F; Mon, 12 Aug 2024 10:08:17 +0200 (CEST) Received: from mail-ed1-f45.google.com (mail-ed1-f45.google.com [209.85.208.45]) by mails.dpdk.org (Postfix) with ESMTP id 9ADEF400D7 for ; Mon, 12 Aug 2024 10:08:16 +0200 (CEST) Received: by mail-ed1-f45.google.com with SMTP id 4fb4d7f45d1cf-5a10bb7bcd0so4998338a12.3 for ; Mon, 12 Aug 2024 01:08:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1723450096; x=1724054896; darn=dpdk.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=yKutEQ2shqnNrAl4vElmh2NRkBu3gde57X5pS65Io1I=; b=ZXLa7N6n3XjceNRqPj4h58moPn1q57GkKWkdHtcKkQamYd97M4idahrmnp/t//Zed4 qbXFleB1TpGMDbuaFPuOTZU6RQ26vn1xiDKNDdOflUrOXFLcs7Bjkt1P6TKSp3Rou8sJ Npt1SCIHE+kMFKE0hwGOHEkv5RqEupoDeau/5TFaZuV1G+K5Cuwgj1+CkXjIaaXG5jC6 rEr0KkHHj/6RDY5Pxnrd0hSLRUbfHtKz7lW+nDA4IVfqIBNH0e0kiF+66pVZq3KufNFB 9w5hX7n76grVSWadbqM7PNebA/Tu6qyyB/NgBKcFhJhzeS854UpdfxL41ywaFmnt3wIt T7VQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723450096; x=1724054896; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=yKutEQ2shqnNrAl4vElmh2NRkBu3gde57X5pS65Io1I=; b=KPa1jxf7xx4fv1W4uniogrtcpeP5uan54ZXrh+OkG9ur2FeK9NRmpPTINA0n4bT2ne bR+P9gwZyg8wcs+19kOfRWcdPlETj/6JQvmxEb9oA9/9Tj5Xvknc0kP/JxdD6ITw+6sm T2BoCheMNGIn81zO+knHw5snYbevdOKCAlAuew1Q2m9vHKBuSlC5wLXwBrB37pNi776U BtqlYh/0XcIVgUq0ble4UAlNanDbSvxPaTyAhLpJq3scsNmTO0nSTbdVBDUV0UP0nLeC Yj1XIIEiHZO5zRyji1zv8HeVjgRzgWB9FfZRlQf/rw55Y3G1IrV7V8YVuCm3wPMn6yLx 1IlQ== X-Forwarded-Encrypted: i=1; AJvYcCVmFugKi4AkQCB4ieZF/y4lDBe9LPcZu2QObqZ+nh+qOxDETw4A5WA6zRDeNPapPknesZlB6aQfqMDUhXQ= X-Gm-Message-State: AOJu0Yx5Gql4bGvdg255H1nIgEloq+1qf4KOrxWiYFUNo5Z5X72mkc2A XUSaottBGjen3CmVp/9O9XzcXhSeHmkcdcDptX1p4SESHQVooRdII63alY68JoE= X-Google-Smtp-Source: AGHT+IH5mIuVpu5PwKUjiTGBP9y7mN65JajdDQhTmpupBk0ovEFwwO0Qz7uJunPYaSU3pOFr2rsXHg== X-Received: by 2002:a17:907:6d28:b0:a7d:a031:7bad with SMTP id a640c23a62f3a-a80aa5a500emr680667566b.16.1723450096106; Mon, 12 Aug 2024 01:08:16 -0700 (PDT) Received: from [192.168.200.22] ([84.245.121.236]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a80bb2136easm208369766b.184.2024.08.12.01.08.15 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 12 Aug 2024 01:08:15 -0700 (PDT) Message-ID: Date: Mon, 12 Aug 2024 10:08:14 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v16 5/5] dts: add API doc generation To: Jeremy Spewock Cc: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, probb@iol.unh.edu, paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu, dev@dpdk.org References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240808085452.426702-1-juraj.linkes@pantheon.tech> <20240808085452.426702-6-juraj.linkes@pantheon.tech> Content-Language: en-US From: =?UTF-8?Q?Juraj_Linke=C5=A1?= In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit 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 > >> --- /dev/null >> +++ b/doc/api/dts/meson.build >> @@ -0,0 +1,29 @@ >> +# SPDX-License-Identifier: BSD-3-Clause >> +# Copyright(c) 2023 PANTHEON.tech s.r.o. > > Should this be 2023 or updated now that we're in 2024? Probably > doesn't matter too much either way. > I've talked to Thomas about copyrights and in essence, the copyright is going to be valid for a long time, so basically there's no need. >> diff --git a/doc/api/meson.build b/doc/api/meson.build >> index 5b50692df9..788129336b 100644 >> --- a/doc/api/meson.build >> +++ b/doc/api/meson.build >> @@ -1,6 +1,18 @@ >> # SPDX-License-Identifier: BSD-3-Clause >> # Copyright(c) 2018 Luca Boccassi >> > > Should you add your copyright to the top of this file now that you've > also modified it? > Possibly, but I actually want to move almost all (or maybe all of if it works) of this one level deeper, so that would make too small of a change to warrant the inclusion of you copyright I think. >> +dts_doc_targets = [] >> +dts_doc_target_names = [] >> +subdir('dts') >> + >> +if dts_doc_targets.length() == 0 >> + dts_message = 'No DTS docs targets found' >> +else >> + dts_message = 'Building DTS docs:' >> +endif >> +run_target('dts-doc', command: [echo, dts_message, dts_doc_target_names], >> + depends: dts_doc_targets) >> + >> doxygen = find_program('doxygen', required: get_option('enable_docs')) >> >> if not doxygen.found() >> @@ -40,6 +52,7 @@ cdata.set('WARN_AS_ERROR', 'NO') >> if get_option('werror') >> cdata.set('WARN_AS_ERROR', 'YES') >> endif >> +cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html')) >> >> # configure HTML Doxygen run >> html_cdata = configuration_data() >> diff --git a/doc/guides/conf.py b/doc/guides/conf.py >> index 0f7ff5282d..d7f3030838 100644 >> --- a/doc/guides/conf.py > >>