From mboxrd@z Thu Jan 1 00:00:00 1970 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=-0.5 required=3.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no 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 7D120C4338F for ; Sun, 1 Aug 2021 21:16:54 +0000 (UTC) Received: from smtp3.osuosl.org (smtp3.osuosl.org [140.211.166.136]) (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 0A729604AC for ; Sun, 1 Aug 2021 21:16:53 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 0A729604AC Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=lists.linuxfoundation.org Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id C3CBB606ED; Sun, 1 Aug 2021 21:16:53 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 6IvpQ1SJNm0S; Sun, 1 Aug 2021 21:16:53 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [IPv6:2605:bc80:3010:104::8cd3:938]) by smtp3.osuosl.org (Postfix) with ESMTPS id D554B605E0; Sun, 1 Aug 2021 21:16:52 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id BC54FC001B; Sun, 1 Aug 2021 21:16:52 +0000 (UTC) Received: from smtp3.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by lists.linuxfoundation.org (Postfix) with ESMTP id C9823C000E for ; Sun, 1 Aug 2021 21:16:51 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id C151160633 for ; Sun, 1 Aug 2021 21:16:51 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id nVBzTgTCoQVP for ; Sun, 1 Aug 2021 21:16:50 +0000 (UTC) X-Greylist: whitelisted by SQLgrey-1.8.0 Received: from mail-lj1-x22c.google.com (mail-lj1-x22c.google.com [IPv6:2a00:1450:4864:20::22c]) by smtp3.osuosl.org (Postfix) with ESMTPS id 4B1A5605E0 for ; Sun, 1 Aug 2021 21:16:50 +0000 (UTC) Received: by mail-lj1-x22c.google.com with SMTP id h9so21322568ljq.8 for ; Sun, 01 Aug 2021 14:16:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=O8PQGZiadxdYRKM0oj9MpECbLIIXkFnT15yyCsUl2r0=; b=f+pcabcL2zj88rOYPYGmNSwBSRPE6eQvPkw10VMW9CrZTbTKBg7RSZEcndm6dPA5Zf xWAFTgjR5UKBCnxt6TVc3yxrZg/Qbb0xSIohlc1A+9aXe83Xh5Hu90qFQp+4UUZ+r/7C P17xrB1E+g65p6cjWvYTtxehsRXww1jLqIEZOa1PAm/MZSf9RuJXCXL5hz1rFp+byc+l h0fHzTTwQBX9oQ9vKv6z0iGrjTgdwXSQnG0ow86aLyPKF6Pl/ohJ5bCn9klUUQYa+mXl XtPvOL2Vtrje42GD7jGIALtvFebyIDUgnSJNsO2zeeVdYf9LLzc4uE1WG5Fb0MZGbnqz o1oA== 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=O8PQGZiadxdYRKM0oj9MpECbLIIXkFnT15yyCsUl2r0=; b=kDOvjYytIWfgpmrm/4Dx8NoUXklxXKX+wAwvfBJJuYEmciA0uFAXqTXujr+ZkC/Ksu c4EzL5oMYhhOTizURZxhnDAepT4ZL5bdunqug2YypQUU4311ha03OeAKkDm/HvaAqrux 1hF8oaaYP7XDDZCq10DS+LeofLeSn0qGFeDtWY/XdsnD0zvftri5h+APFcFSnQwCtIed Sgimf8gH07uoubm9T58lBEOG4O7Xur/oGDjeGFIaLR3g0hpA3dQ7dq077POzYzYcFfcW Yy+CH9FYDsPIwQfrid7LcgZcAS2X5T8WXLmNU1HLMlAG912n8Dnw7KlyblsZOVkkdacM mO/Q== X-Gm-Message-State: AOAM5309K5e7SQJ9+RiS3zYswmkRfRg/GGmRlv71adm/17WaJfNkKBFe JI1MZaRhp9kKwYQuiT5yl1TfQKTRltCfnJjySYg= X-Google-Smtp-Source: ABdhPJzmyR0cy6QUmUxlyVscHkBXhSneY6aioxabaqw7lYYv2NfkNrCS4GnhZtwMqVkhkzv5o+wtU2orQM3fJwF82mo= X-Received: by 2002:a2e:8044:: with SMTP id p4mr7510833ljg.324.1627852608140; Sun, 01 Aug 2021 14:16:48 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Dwaipayan Ray Date: Mon, 2 Aug 2021 02:46:36 +0530 Message-ID: Subject: Re: Linux Kernel: Checkpatch Documentation To: Anuj Pandey Cc: linux-kernel-mentees@lists.linuxfoundation.org X-BeenThere: linux-kernel-mentees@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-kernel-mentees-bounces@lists.linuxfoundation.org Sender: "Linux-kernel-mentees" On Sun, Aug 1, 2021 at 1:43 PM Anuj Pandey wrote: > > I am interested in the Checkpatch Documentation mentorship program and I would like to work on the tasks for the mentee selection > > Thanks & Regards, > Anuj Pandey Thanks for your interest in working with the checkpatch documentation. The zeroth task is to learn suitable netiquette for the communication with the kernel community. Below are some basic rules and pointers for this mentorship. More information on kernel netiquette is also at https://people.kernel.org/tglx/notes-about-netiquette. First, please do not top-post. A: Because we read from top to bottom, left to right. Q: Why should I start my reply below the quoted text? A: Because it messes up the order in which people normally read text. Q: Why is top-posting such a bad thing? A: The lost context. Q: What makes top-posted replies harder to read than bottom-posted? A: Yes. Q: Should I trim down the quoted part of an email to which I'm replying? Second, please always CC: linux-kernel-mentees@lists.linuxfoundation.org. Third, set up your email client according to the kernel community rules. Here is some information to that: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#no-mime-no-links-no-compression-no-attachments-just-plain-text https://www.kernel.org/doc/html/latest/process/email-clients.html Generally more information on submitting patches and responding on replies is at https://www.kernel.org/doc/html/latest/process/submitting-patches.html Once the zeroth task is understood, you can now move on to the first task: Running checkpatch on a specific file. Get a clone of the Linux kernel repository. The script checkpatch.pl is under the scripts directory. Then, the first task is to run checkpatch.pl on a few files below and share the results: drivers/pinctrl/renesas/pinctrl.c drivers/clk/tegra/clk-tegra124-emc.c Which information on these rules that checkpatch warns about is available in the Checkpatch Documentation? If documentation of these rules is available, explain your understanding of the rules in your own words. If no information is available in the documentation, explain your understanding of the rule. In any case, explain the violation that is checked and raised in the checkpatch script, i.e., what is implemented in checkpatch to check the rule and possible violations. Which code in the checkpatch script is raising the warning? What does it check and how is that implemented? Explain how to possibly fix this code with regards to that violation. Once you succeed on this first task, we inform you about the further second and third task. If you fail on any of those tasks, you are out of the selection process. The selection of the mentee will happen according to schedule, at earliest on August 12th and at latest at the end of August. More information is available at https://docs.linuxfoundation.org/lfx/mentorship/mentorship-program-timelines. All the best, Dwaipayan. _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees