From patchwork Fri Feb 21 22:17:53 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Yann E. MORIN" X-Patchwork-Id: 323058 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from silver.osuosl.org (silver.osuosl.org [140.211.166.136]) by ozlabs.org (Postfix) with ESMTP id A7D052C0305 for ; Sat, 22 Feb 2014 09:18:15 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id F0C542019B; Fri, 21 Feb 2014 22:18: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 o2N710N-fLPt; Fri, 21 Feb 2014 22:18:10 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by silver.osuosl.org (Postfix) with ESMTP id CCCC932F3C; Fri, 21 Feb 2014 22:18:06 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ash.osuosl.org (Postfix) with ESMTP id 2CDC41BF862 for ; Fri, 21 Feb 2014 22:18:00 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 279488C5F5 for ; Fri, 21 Feb 2014 22:18:00 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ZCMBJUo6MhrA for ; Fri, 21 Feb 2014 22:17:59 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-wi0-f175.google.com (mail-wi0-f175.google.com [209.85.212.175]) by whitealder.osuosl.org (Postfix) with ESMTPS id 1A4868C346 for ; Fri, 21 Feb 2014 22:17:58 +0000 (UTC) Received: by mail-wi0-f175.google.com with SMTP id hm4so1326750wib.14 for ; Fri, 21 Feb 2014 14:17:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references; bh=nwvg4YCGb9NGG+PlDoZ1OGIMayh1ptVTKovliJ1Ibhc=; b=AlD4r87UOe8wKJaSZfDBUV4YQmr8r9tPVoYnKR/b+lNXjvM6dG4VQfP9QZVlLIz/rG zPwbevzp1BTrZFs7fkvlvZR8jsD1Bci8Kqq5g41YmY9epLjYXJtgQGZVbUFiTCIYViS9 gDn8iY1YMzLhQ84Rc+C/8NGCrtvoWs8aw7LagCb8hENAsZPnK9RkYvrXfh1obgm9pFne vIvTQeziieQ0aSPtYXUOiIPyX+PX2w8Pg6hh8ZXBCccF68oZm2Yr5UTIRGjV7iT1pNHt esd57YV+hk4cKkYRGqZHjoJO6OAObQJgtvx0Nx+wKV68RzO+NzWH9MFf+CsNTCD4wP92 zlOQ== X-Received: by 10.194.2.194 with SMTP id 2mr2128619wjw.73.1393021077547; Fri, 21 Feb 2014 14:17:57 -0800 (PST) Received: from gourin.bzh.lan (ks3095497.kimsufi.com. [94.23.60.27]) by mx.google.com with ESMTPSA id ha1sm20165416wjc.23.2014.02.21.14.17.56 for (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 21 Feb 2014 14:17:56 -0800 (PST) From: "Yann E. MORIN" To: buildroot@buildroot.org Date: Fri, 21 Feb 2014 23:17:53 +0100 Message-Id: X-Mailer: git-send-email 1.8.1.2 In-Reply-To: References: Cc: "Yann E. MORIN" Subject: [Buildroot] [PATCH 2/3] manual: switch BR2_EXTERNAL examples to use absolute paths X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net From: "Yann E. MORIN" Although it is possible to use relative paths, there are a few pitfalls whith doing so. To avoid confusion for a (newcoming) user, use absolute paths in the manual (as is done in examples for $(O)), since it is guaranteed to be working without corner cases. Signed-off-by: "Yann E. MORIN" Cc: Samuel Martin --- Note: we only change our examples in the manual; using relative paths is still possible. There is no additional blurb in the manual that would favour using relative or absolute paths. --- docs/manual/customize-outside-br.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt index 585eedf..134ed64 100644 --- a/docs/manual/customize-outside-br.txt +++ b/docs/manual/customize-outside-br.txt @@ -30,18 +30,18 @@ there is no need to pass +BR2_EXTERNAL+ at every +make+ invocation. It can however be changed at any time by passing a new value, and can be removed by passing an empty value. -The +BR2_EXTERNAL+ path can be either an absolute or a relative path, +*Note:* the +BR2_EXTERNAL+ path can be either an absolute or a relative path, but if it's passed as a relative path, it is important to note that it -is interpreted relatively to the main Buildroot source directory, not +is interpreted relatively to the main Buildroot source directory, *not* the Buildroot output directory. Some examples: ----- - buildroot/ $ make BR2_EXTERNAL=../foobar menuconfig + buildroot/ $ make BR2_EXTERNAL=/path/to/foobar menuconfig ----- -Starting from now on, external definitions from the +../foobar+ +Starting from now on, external definitions from the +/path/to/foobar+ directory will be used: ----- @@ -52,7 +52,7 @@ directory will be used: We can switch to another external definitions directory at any time: ----- - buildroot/ $ make BR2_EXTERNAL=../barfoo xconfig + buildroot/ $ make BR2_EXTERNAL=/where/we/have/barfoo xconfig ----- Or disable the usage of external definitions: