From patchwork Thu Dec 2 21:57:47 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexey Brodkin X-Patchwork-Id: 1563015 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: bilbo.ozlabs.org; dkim=pass (2048-bit key; secure) header.d=lists.infradead.org header.i=@lists.infradead.org header.a=rsa-sha256 header.s=bombadil.20210309 header.b=ykRiGGAK; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=synopsys.com header.i=@synopsys.com header.a=rsa-sha256 header.s=mail header.b=L7YnaS0v; dkim-atps=neutral Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=lists.infradead.org (client-ip=2607:7c80:54:e::133; helo=bombadil.infradead.org; envelope-from=linux-snps-arc-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org; receiver=) Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by bilbo.ozlabs.org (Postfix) with ESMTPS id 4J4qZq3vpNz9s5P for ; Fri, 3 Dec 2021 08:58:11 +1100 (AEDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=lqFZT3n/iVBGeliBRAXT9BcZj5iZ244A9NSHKwo0QlA=; b=ykRiGGAKs7esL0 YNX6mxBi3gpbBWTfMDqWGbiUKZpRWWsO/c0+iPiAVUy+rYC2Wl8xsssLnhX/C5F+jLzjsbjvk8t/N wGJ+EPqr2QKs0HBvZJ27IF2mC+JNDRxHQcaBR/dSvYXrKuh0TOgwK5RRtbjgKBMxGiHHxGlucy7Dt korKYKoepTMwkhH5eEwKedCOyVrpMrR7SGcHZuCBczGdJYORxueCtpY5ICUuhIYOVXqOUUZOhZQ6c sbpPRlocwPtiTOsR7SeE3YGvFXNjrJU5I+KpFHFdQY0+7fKF5U3ifeH6a77MSiN5nRzPJg480IFE4 SpXqbXhmWFF3yM8EJn1w==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1msu5h-00DX4z-8l; Thu, 02 Dec 2021 21:58:09 +0000 Received: from smtprelay-out1.synopsys.com ([149.117.73.133]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1msu5e-00DX3r-2W for linux-snps-arc@lists.infradead.org; Thu, 02 Dec 2021 21:58:07 +0000 Received: from mailhost.synopsys.com (mdc-mailhost1.synopsys.com [10.225.0.209]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (Client CN "mailhost.synopsys.com", Issuer "SNPSica2" (verified OK)) by smtprelay-out1.synopsys.com (Postfix) with ESMTPS id A249A459CC; Thu, 2 Dec 2021 21:58:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1638482281; bh=ZVPpzB6rSNcngrIBnZii0uhQIavPsuCgmP8/mOzVavE=; h=From:To:Cc:Subject:Date:From; b=L7YnaS0vQx3fTlAeYVedMHwNa1hkBi4fleITEWzhP2SG+y2Yx439NI8KpvTxGdgjk y8/9UIirG9DLGDdioVh8a7CcKCaGoCM1R7aukYyYzi04cUNFae4mP/rbDwoeFOZPyh FBL70ll4iHRikjdWjF8nqa5iXcQNPPW27ZLZ1SeiEC+AhFVgkrMP0hdonlGqlrH5sw oUR7rEfyrNDFHbvaR4265VgRbG6bDVNq6rJ+/nGCHSQr84Jy0AYzWgquo8O9s+lqcX pb84HmH+0anL5KeOGzehq8phcNrhwh/YfKK4VJhhb3iiVulk6TnKIvAUN7cOT19843 8BmPLnwZg1kYQ== Received: from abrodkin-5550.internal.synopsys.com (unknown [10.225.48.86]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (Client did not present a certificate) by mailhost.synopsys.com (Postfix) with ESMTPSA id EC080A005C; Thu, 2 Dec 2021 21:57:56 +0000 (UTC) X-SNPS-Relay: synopsys.com From: Alexey Brodkin To: linux-doc@vger.kernel.org Cc: linux-snps-arc@lists.infradead.org, Alexey Brodkin , Randy Dunlap , Jonathan Corbet , Vineet Gupta Subject: [PATCH] docs: ARC: Improve readability Date: Fri, 3 Dec 2021 00:57:47 +0300 Message-Id: <20211202215747.19923-1-abrodkin@synopsys.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20211202_135806_130930_4F0DE570 X-CRM114-Status: GOOD ( 17.08 ) X-Spam-Score: -0.2 (/) X-Spam-Report: Spam detection software, running on the system "bombadil.infradead.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: There were some things which made rendered document look not very elegant. That was because: 1. Numbered lists were formatted in more of Markdown way rather than true reStructuredText and so were displayed as a plain text with leading numbers. Content analysis details: (-0.2 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 0.0 RCVD_IN_MSPIKE_H4 RBL: Very Good reputation (+4) [149.117.73.133 listed in wl.mailspike.net] 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record 0.0 SPF_NONE SPF: sender does not publish an SPF Record -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain 0.0 RCVD_IN_MSPIKE_WL Mailspike good senders X-BeenThere: linux-snps-arc@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Linux on Synopsys ARC Processors List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-snps-arc" Errors-To: linux-snps-arc-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org There were some things which made rendered document look not very elegant. That was because: 1. Numbered lists were formatted in more of Markdown way rather than true reStructuredText and so were displayed as a plain text with leading numbers. Well, moreover numbered lists were not needed as in all cases we were just listing a couple of options w/o any intention to follow any particular order, so a simpler unordered list fits better and looks cleaner. 2. URL's of external resources were added as they are (which is OK in a plain text, but make not much sense in a HTML where we may use more human-friendly link names with URL's hidden. 3. Some URL's had trailing slashes which were not really needed Fix all items from above! Signed-off-by: Alexey Brodkin Cc: Randy Dunlap Cc: Jonathan Corbet Cc: Vineet Gupta --- Documentation/arc/arc.rst | 62 +++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 29 deletions(-) diff --git a/Documentation/arc/arc.rst b/Documentation/arc/arc.rst index 249d03c6be8e..6c4d978f3f4e 100644 --- a/Documentation/arc/arc.rst +++ b/Documentation/arc/arc.rst @@ -9,24 +9,27 @@ Other sources of information Below are some resources where more information can be found on ARC processors and relevant open source projects. -1. ``_ - Community portal for open source on ARC. -Good place to start to find relevant FOSS projects, toolchain releases, -news items and more. - -2. ``_ - -Home for all development activities regarding open source projects for -ARC processors. Some of the projects are forks of various upstream projects, -where "work in progress" is hosted prior to submission to upstream projects. -Other projects are developed by Synopsys and made available to community -as open source for use on ARC Processors. - -3. ``_ - -Official Synopsys ARC Processors website location, with access to some IP -documentation (Programmer's Reference Manuals, AKA "PRM's", see -``_) -and commercial tools (Free nSIM, -``_ and -MetaWare Light Edition, ``_) +- ``_ - Community portal for open source on ARC. + Good place to start to find relevant FOSS projects, toolchain releases, + news items and more. + +- ``_ - + Home for all development activities regarding open source projects for + ARC processors. Some of the projects are forks of various upstream projects, + where "work in progress" is hosted prior to submission to upstream projects. + Other projects are developed by Synopsys and made available to community + as open source for use on ARC Processors. + +- `Official Synopsys ARC Processors website + `_ - + location, with access to some IP documentation (`Programmer's Reference + Manual, AKA PRM for ARC HS processors + `_) + and free versions of some commercial tools (`Free nSIM + `_ and + `MetaWare Light Edition `_). + Please note though, registration is required to access both the documentation and + the tools. Important note on ARC processors configurability ################################################ @@ -52,22 +55,23 @@ Building the Linux kernel for ARC processors The process of kernel building for ARC processors is the same as for any other architecture and could be done in 2 ways: -1. cross-compilation: process of compiling for ARC targets on a development -host with a different processor architecture (generally x86_64/amd64). - -2. native compilation: process of compiling for ARC on a ARC platform -(hardware board or a simulator like QEMU) with complete development environment -(GNU toolchain, dtc, make etc) installed on the platform. +- Cross-compilation: process of compiling for ARC targets on a development + host with a different processor architecture (generally x86_64/amd64). +- Native compilation: process of compiling for ARC on a ARC platform + (hardware board or a simulator like QEMU) with complete development environment + (GNU toolchain, dtc, make etc) installed on the platform. In both cases, up-to-date GNU toolchain for ARC for the host is needed. Synopsys offers prebuilt toolchain releases which can be used for this purpose, available from: -1. Synopsys GNU toolchain releases: -``_ -2. Linux kernel compilers collection: -``_ -3. Bootlin's toolchain collection: ``_ +- Synopsys GNU toolchain releases: + ``_ + +- Linux kernel compilers collection: + ``_ + +- Bootlin's toolchain collection: ``_ Once the toolchain is installed in the system, make sure its "bin" folder is added in your ``PATH`` environment variable. Then set ``ARCH=arc`` &