From patchwork Mon May 13 10:37:42 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Charlie Turner X-Patchwork-Id: 1098792 Return-Path: X-Original-To: incoming-buildroot@patchwork.ozlabs.org Delivered-To: patchwork-incoming-buildroot@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=busybox.net (client-ip=140.211.166.136; helo=silver.osuosl.org; envelope-from=buildroot-bounces@busybox.net; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=igalia.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=igalia.com header.i=@igalia.com header.b="S/HqJUu/"; dkim-atps=neutral Received: from silver.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 ozlabs.org (Postfix) with ESMTPS id 452cjS4bHdz9s4V for ; Mon, 13 May 2019 20:38:18 +1000 (AEST) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id A07112550C; Mon, 13 May 2019 10:38:14 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 9EnqznXeKzae; Mon, 13 May 2019 10:38:10 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by silver.osuosl.org (Postfix) with ESMTP id 9C3DB248F6; Mon, 13 May 2019 10:38:10 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137]) by ash.osuosl.org (Postfix) with ESMTP id D25301BF873 for ; Mon, 13 May 2019 10:38:06 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id 7DDDE85507 for ; Mon, 13 May 2019 10:38:06 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id d0qwLVuKYiZB for ; Mon, 13 May 2019 10:38:05 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from fanzine.igalia.com (fanzine.igalia.com [91.117.99.155]) by fraxinus.osuosl.org (Postfix) with ESMTPS id E864285522 for ; Mon, 13 May 2019 10:38:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=igalia.com; s=20170329; h=Message-Id:Date:Subject:Cc:To:From; bh=TsaAdpGnDJJeR7cZ51cLFYgC78lQsHWu+hYqIUw4CEo=; b=S/HqJUu/nsKRnhRtWQNueIO6kXi9DeJZbawhKix5XaUaWEHpRPTbDCUx4qjKmigJz6VLO416qHdcgjXbab4ZPlO30sbbRENcYf0epSd5LLMPdYIV8DNyafBh14UW+aTo566m2WQQvMVER4nIsm9YjegSNtit3racpceREH70RYY7Ig0YdxvJHM1FX03S6QD70LCqH7yc6bx8B3rWCwg5TmoWxTp9EQym/L+6yS34HG38p9wYgz4+Mjbq6vS2QXQLYWeCBBJ0dyBPxQ1YQm8O4+XRFKBkG9Ar8xaouD4CaIrX0sa9j7TkKYHDATbvLLAMlLjvLFZVol2kPpzz+VLy2w==; Received: from 222.107.6.51.dyn.plus.net ([51.6.107.222] helo=buildmachine.lan) by fanzine.igalia.com with esmtpsa (Cipher TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim) id 1hQ8LJ-00030V-GV; Mon, 13 May 2019 12:38:01 +0200 From: Charlie Turner To: buildroot@buildroot.org Date: Mon, 13 May 2019 11:37:42 +0100 Message-Id: <20190513103742.24692-1-cturner@igalia.com> X-Mailer: git-send-email 2.17.1 Subject: [Buildroot] [PATCH 1/1] docs/manual: Clarify location of local.mk X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.29 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Thomas De Schampheleire , Charlie Turner MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: "buildroot" In particular, the manual was incorrect when the user had selected an out-of-tree build. Signed-off-by: Charlie Turner --- docs/manual/using-buildroot-development.txt | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/manual/using-buildroot-development.txt b/docs/manual/using-buildroot-development.txt index 3389a37b39..65a9f1a3f7 100644 --- a/docs/manual/using-buildroot-development.txt +++ b/docs/manual/using-buildroot-development.txt @@ -28,10 +28,22 @@ clean+. Therefore, Buildroot provides a specific mechanism for this use case: the +_OVERRIDE_SRCDIR+ mechanism. Buildroot reads an _override_ file, which allows the user to tell Buildroot the location of the -source for certain packages. By default this _override_ file is named -+local.mk+ and located in the top directory of the Buildroot source -tree, but a different location can be specified through the -+BR2_PACKAGE_OVERRIDE_FILE+ configuration option. +source for certain packages. + +The default location of the override file is +$(CONFIG_DIR)/local.mk+, +as defined by the +BR2_PACKAGE_OVERRIDE_FILE+ configuration option. ++$(CONFIG_DIR)+ is the location of the Buildroot +.config+ file, so ++local.mk+ by default lives side-by-side with the +.config+ file, +which means: + +* In the top-level Buildroot source directory for in-tree builds + (i.e., when +O=+ is not used) +* In the out-of-tree directory for out-of-tree builds (i.e., when + +O=+ is used) + +If a different location than these defaults is required, it can be +specified through the +BR2_PACKAGE_OVERRIDE_FILE+ configuration +option. In this _override_ file, Buildroot expects to find lines of the form: