diff mbox series

[1/2] libtracefs: clean also docs by default

Message ID 20220124105252.64897-1-krzysztof.kozlowski@canonical.com (mailing list archive)
State Rejected
Headers show
Series [1/2] libtracefs: clean also docs by default | expand

Commit Message

Krzysztof Kozlowski Jan. 24, 2022, 10:52 a.m. UTC
Logical is that `make clean` cleans everything done from build, not only
parts.  Leaving the documentation unclean requires additional step
when building for example Debian packages:

    $ dpkg-buildpackage -us -uc
    ...
    dpkg-source: info: local changes detected, the modified files are:

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
---
 Makefile | 1 +
 1 file changed, 1 insertion(+)

Comments

Steven Rostedt Feb. 4, 2022, 2:41 a.m. UTC | #1
On Mon, 24 Jan 2022 11:52:51 +0100
Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> wrote:

> Logical is that `make clean` cleans everything done from build, not only
> parts.  Leaving the documentation unclean requires additional step
> when building for example Debian packages:
> 
>     $ dpkg-buildpackage -us -uc
>     ...
>     dpkg-source: info: local changes detected, the modified files are:

The reason we did this is because docs are not made by default.

(Yes you can say the same about utest, src and samples but those are all
code).

I've always kept the doc build (and cleanup) separate from the normal build.

Is it normal to remove the docs in other projects?

-- Steve



> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
> ---
>  Makefile | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Makefile b/Makefile
> index 544684c1c37c..4650d15d64e9 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -375,6 +375,7 @@ samples: libtracefs.a force
>  	$(Q)$(call descend,$(src)/samples,all)
>  
>  clean:
> +	$(Q)$(call descend_clean,Documentation)
>  	$(Q)$(call descend_clean,utest)
>  	$(Q)$(call descend_clean,src)
>  	$(Q)$(call descend_clean,samples)
Krzysztof Kozlowski Feb. 4, 2022, 8:59 a.m. UTC | #2
On 04/02/2022 03:41, Steven Rostedt wrote:
> On Mon, 24 Jan 2022 11:52:51 +0100
> Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> wrote:
> 
>> Logical is that `make clean` cleans everything done from build, not only
>> parts.  Leaving the documentation unclean requires additional step
>> when building for example Debian packages:
>>
>>     $ dpkg-buildpackage -us -uc
>>     ...
>>     dpkg-source: info: local changes detected, the modified files are:
> 
> The reason we did this is because docs are not made by default.
> 
> (Yes you can say the same about utest, src and samples but those are all
> code).
> 
> I've always kept the doc build (and cleanup) separate from the normal build.
> 
> Is it normal to remove the docs in other projects?

I don't know actually, but I find natural that clean removes all
objects, even ones not created by "make all".

I see your point, so I do not insist on this solution. I can fix the
incomplete cleaning on Debian package side.

Best regards,
Krzysztof
Steven Rostedt Feb. 4, 2022, 1:21 p.m. UTC | #3
On Fri, 4 Feb 2022 09:59:06 +0100
Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> wrote:


> I don't know actually, but I find natural that clean removes all
> objects, even ones not created by "make all".

The main reason I like to keep documentation clean and code clean
separate, is because when I develop between different branches,
checking out an older one then a newer one, the make dependencies can
get screwed up. A make clean usually solves the issue when that
happens. But I don't want to rebuild the documentation every time I do
a make clean.

> 
> I see your point, so I do not insist on this solution. I can fix the
> incomplete cleaning on Debian package side.
> 

Great. I'll take the second patch and drop this one then.

Thanks for your contributions!

-- Steve
diff mbox series

Patch

diff --git a/Makefile b/Makefile
index 544684c1c37c..4650d15d64e9 100644
--- a/Makefile
+++ b/Makefile
@@ -375,6 +375,7 @@  samples: libtracefs.a force
 	$(Q)$(call descend,$(src)/samples,all)
 
 clean:
+	$(Q)$(call descend_clean,Documentation)
 	$(Q)$(call descend_clean,utest)
 	$(Q)$(call descend_clean,src)
 	$(Q)$(call descend_clean,samples)