From patchwork Fri Mar 11 17:41:13 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "Yann E. MORIN" X-Patchwork-Id: 596396 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from whitealder.osuosl.org (smtp1.osuosl.org [140.211.166.138]) by ozlabs.org (Postfix) with ESMTP id 6C75E14031B for ; Sat, 12 Mar 2016 04:41:53 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b=JGxIMJMJ; dkim-atps=neutral Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id AE88F9247B; Fri, 11 Mar 2016 17:41:52 +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 EWf37vzOOLTM; Fri, 11 Mar 2016 17:41:49 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by whitealder.osuosl.org (Postfix) with ESMTP id 958549245D; Fri, 11 Mar 2016 17:41:35 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from hemlock.osuosl.org (smtp2.osuosl.org [140.211.166.133]) by ash.osuosl.org (Postfix) with ESMTP id 83C8C1C1E7D for ; Fri, 11 Mar 2016 17:41:32 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id 7EE9095B8D for ; Fri, 11 Mar 2016 17:41:32 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id RUcsLkV5s6SF for ; Fri, 11 Mar 2016 17:41:32 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-wm0-f68.google.com (mail-wm0-f68.google.com [74.125.82.68]) by hemlock.osuosl.org (Postfix) with ESMTPS id BE03A8876B for ; Fri, 11 Mar 2016 17:41:31 +0000 (UTC) Received: by mail-wm0-f68.google.com with SMTP id l68so3701368wml.3 for ; Fri, 11 Mar 2016 09:41:31 -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 :mime-version:content-transfer-encoding; bh=2oB8mc3vRUKNnU9oPGriR4gRVlEvpgZXgImXlxMB3LM=; b=JGxIMJMJFq4uJOq592o+TnLzvDSHf78/dq74NfgHHkbDrvdgdTmnmrafEVhY7dQ0qZ dN9bPNMEEAOtCvIMNc3BoJmjFGWUemDRzrK1/+0yS8NY28ECQ2UAQ3NC+oNjL9UWEFqb SQFLuJOrQiDDG782iFbt4pl9/0SBqmFVTsLzV8EEfkE3kdAXkyLCj2Y9nr2qgqNq+VOh jSLrzVFOhdiLE/9h2DbANoB43os/zmcO2LPRRhZT2UeDGLV6vdQm0kEoGNwo2QO3ntE4 49WuZHyadYCbZY/SbazPtF3qrZ1nc//pDTaZsJ3G6Sg19TmoFjw0N6sjQ9qE14xSPpyn 3xKw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=2oB8mc3vRUKNnU9oPGriR4gRVlEvpgZXgImXlxMB3LM=; b=dL+Q687fQ2xJsag5vKvfWvdmMqK0H1vW7n5tOhGP+MWVf4x903jv1fYFPQrZ0eSfZu pPYqeKrq498LXDmmS2S+Pu0Mb7TRy/IyhZbH/VnSi+UTjRK1pvVZsSw5BXHJK4EgN3Q3 jjNtlMjBAtomv0h6Q0i+kR+kKFKpPu+5HvWc6up/fPLRCZwI0pHIqQ6IMNZOmMiPrIh3 nHiwo62ypI0BgmvjMxTSWWLrBZ02aWM4hS9M8oQp9/awtPzarPxIINl19EqA0HOJWQsO jfkak6ugbpki9ZYFuA6nRFrL5ZQPB1ztOq1NcreR2wBL3RbHLl6zzronbDbHRkS2Mp/g GZGg== X-Gm-Message-State: AD7BkJIU+8jX9s/5ppWlZOwhTyJfS0KzaJ7rksa6njLI4SX1MZKWsz2T8FXrpgocC/N8Yw== X-Received: by 10.28.0.136 with SMTP id 130mr4295084wma.28.1457718090442; Fri, 11 Mar 2016 09:41:30 -0800 (PST) Received: from gourin.bzh.lan (ns304657.ip-46-105-103.eu. [46.105.103.66]) by smtp.gmail.com with ESMTPSA id da6sm9455907wjb.24.2016.03.11.09.41.28 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 11 Mar 2016 09:41:29 -0800 (PST) From: "Yann E. MORIN" To: buildroot@buildroot.org Date: Fri, 11 Mar 2016 18:41:13 +0100 Message-Id: <74636e9e0bf960bd547741d3b172e562c7ed3ad0.1457717002.git.yann.morin.1998@free.fr> X-Mailer: git-send-email 1.9.1 In-Reply-To: References: MIME-Version: 1.0 Cc: Thomas Petazzoni , "Yann E. MORIN" , =?UTF-8?q?J=C3=A9r=C3=B4me=20Pouiller?= Subject: [Buildroot] [PATCH 5/9 v2] core/pkg-generic: add help about package-specific rules X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.18-1 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: buildroot-bounces@busybox.net Sender: "buildroot" Add a package-variable to store the package-specific make rules. Although this variable would be seldom used, we still document it. However, we make sure the documentation explicitly states that this variable should not be used (if it needs to be, the submitter of a package will be told so during reviews). Signed-off-by: "Yann E. MORIN" Cc: Jérôme Pouiller Cc: Arnout Vandecappelle Cc: Thomas Petazzoni --- Makefile | 1 + docs/manual/adding-packages-generic.txt | 6 ++++++ package/pkg-generic.mk | 2 ++ 3 files changed, 9 insertions(+) diff --git a/Makefile b/Makefile index ea8b1e4..fd953b2 100644 --- a/Makefile +++ b/Makefile @@ -934,6 +934,7 @@ help-internal: @echo ' -dirclean - Remove build directory' @echo ' -reconfigure - Restart the build from the configure step' @echo ' -rebuild - Restart the build from the build step' + @$(call print-help,$(PACKAGE_HELP)) ifeq ($(BR2_PACKAGE_BUSYBOX),y) @echo ' busybox-menuconfig - Run BusyBox menuconfig' endif diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt index 8ed7fe8..0e36ffa 100644 --- a/docs/manual/adding-packages-generic.txt +++ b/docs/manual/adding-packages-generic.txt @@ -436,6 +436,12 @@ information is (assuming the package name is +libfoo+) : FLAT binary format is only 4k bytes. If the application consumes more stack, append the required number here. +* +LIBFOO_HELP+ defines the help entries visible when running `make help`. + The expected content for this variable is a list of single- or double- + quoted strings, with each string in the format "action : help for action". + This is seldom used, as packages rarely have custom rules. Do not use + this variable. + The recommended way to define these variables is to use the following syntax: diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk index 3904c09..335b811 100644 --- a/package/pkg-generic.mk +++ b/package/pkg-generic.mk @@ -910,6 +910,8 @@ ifeq ($$(patsubst %/,ERROR,$$($(2)_SITE)),ERROR) $$(error $(2)_SITE ($$($(2)_SITE)) cannot have a trailing slash) endif +PACKAGE_HELP += $$($(2)_HELP) + endif # $(2)_KCONFIG_VAR endef # inner-generic-package