From patchwork Thu Mar 25 22:58:59 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 12165129 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C3DF5C433E0 for ; Thu, 25 Mar 2021 22:59:13 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id EC3A2619A3 for ; Thu, 25 Mar 2021 22:59:12 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org EC3A2619A3 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=ffwll.ch Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=intel-gfx-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id D8DC66EE52; Thu, 25 Mar 2021 22:59:08 +0000 (UTC) Received: from mail-wm1-x32a.google.com (mail-wm1-x32a.google.com [IPv6:2a00:1450:4864:20::32a]) by gabe.freedesktop.org (Postfix) with ESMTPS id 856636E0E9 for ; Thu, 25 Mar 2021 22:59:07 +0000 (UTC) Received: by mail-wm1-x32a.google.com with SMTP id u5-20020a7bcb050000b029010e9316b9d5so2049792wmj.2 for ; Thu, 25 Mar 2021 15:59:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=EYLAWqcsMKDolKIh91LZ+I8bx1uPc3WQVcxAOCVSz0Y=; b=KFqy/DGLzDjuFj0f1M+Y/xrOiDMrkKVyMmO5QcV9vKb+rEY33Gl+Y+y5RB4uZ0W3jx IyHptOPH+h8owlKH6lv3aLQhMvev7/ugdMHvARscdxriDVSmbEFhm2WPdn6eqybHjTwX c6tF/3dvRN66vjwWTmnbde59D/+Kb8AeWMLBc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=EYLAWqcsMKDolKIh91LZ+I8bx1uPc3WQVcxAOCVSz0Y=; b=ioVjTYfNBPWiOtj/i/cNcaGOAvY2HqwyLGSAGmAF3Bxuwl6hOygv4YfWNEIao+rZGQ f64mWP+vRi6MQx6ZTdYmNSVWfCck9eSyf0GTiM4jc5HMieaHBZx2m8tu8rHANezRFQHS hldF5IM8gVugsPT2j5j1SpFB3dkbih7fVtcHWWuNDWOuEEXgQaUNRk7YrU7E+yRaki2X zrwS5Y1ykZCHXTIWDstScRqApBNXzJiejPmKEfG045HKqq69Dp+AnqqeGUgYSVXprjpH pudB48wUYIlDcrHcFBA4hT48+kmepiK9AmkxzXVBN8sJ4NgbfeELgf5mzcJhlYx+7hh8 W0LQ== X-Gm-Message-State: AOAM532V91MD6/26sEaYsHPwq2a8RDD0ogoxkqPdTKumkot65MnmDGS7 7JfRTPwK/jFeYjEjY8pPz8/kGQ== X-Google-Smtp-Source: ABdhPJyyicXQnz93qvCTMUfXLPa6Gl52zpEX47MiJTDo36jyJysWZj3OvJmmxloStIQmm4TBYvCZNA== X-Received: by 2002:a1c:c20a:: with SMTP id s10mr10080667wmf.144.1616713146219; Thu, 25 Mar 2021 15:59:06 -0700 (PDT) Received: from phenom.ffwll.local ([2a02:168:57f4:0:efd0:b9e5:5ae6:c2fa]) by smtp.gmail.com with ESMTPSA id q4sm7814842wma.20.2021.03.25.15.59.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Mar 2021 15:59:05 -0700 (PDT) From: Daniel Vetter To: DRI Development Date: Thu, 25 Mar 2021 23:58:59 +0100 Message-Id: <20210325225859.1684116-1-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 2.31.0 In-Reply-To: <20210324211041.1354941-2-daniel.vetter@ffwll.ch> References: <20210324211041.1354941-2-daniel.vetter@ffwll.ch> MIME-Version: 1.0 Subject: [Intel-gfx] [PATCH] drm/doc: Add RFC section X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Simon Ser , Daniel Vetter , Daniel Vetter , Intel Graphics Development , Dave Airlie Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" Motivated by the pre-review process for i915 gem/gt features, but probably useful in general for complex stuff. v2: Add reminder to not forget userspace projects in the discussion (Simon, Jason) v3: Actually put this into a folder, so we have it all (.rst files and headers for kerneldoc) contained somewhere separate (Jason) Cc: Simon Ser Cc: Jani Nikula Cc: Joonas Lahtinen Cc: Rodrigo Vivi Cc: Jason Ekstrand Cc: Dave Airlie Acked-by: Jason Ekstrand Acked-by: Simon Ser Acked-by: Rodrigo Vivi Acked-by: Dave Airlie Signed-off-by: Daniel Vetter --- Documentation/gpu/index.rst | 1 + Documentation/gpu/rfc/index.rst | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 Documentation/gpu/rfc/index.rst diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst index c9a51e3bfb5a..ec4bc72438e4 100644 --- a/Documentation/gpu/index.rst +++ b/Documentation/gpu/index.rst @@ -16,6 +16,7 @@ Linux GPU Driver Developer's Guide vga-switcheroo vgaarbiter todo + rfc/index .. only:: subproject and html diff --git a/Documentation/gpu/rfc/index.rst b/Documentation/gpu/rfc/index.rst new file mode 100644 index 000000000000..a8621f7dab8b --- /dev/null +++ b/Documentation/gpu/rfc/index.rst @@ -0,0 +1,17 @@ +=============== +GPU RFC Section +=============== + +For complex work, especially new uapi, it is often good to nail the high level +design issues before getting lost in the code details. This section is meant to +host such documentation: + +* Each RFC should be a section in this file, explaining the goal and main design + considerations. Especially for uapi make sure you Cc: all relevant project + mailing lists and involved people outside of dri-devel. + +* For uapi structures add a file to this directory with and then pull the + kerneldoc in like with real uapi headers. + +* Once the code has landed move all the documentation to the right places in + the main core, helper or driver sections.