Re: [PATCH 3/4] docs: netlink: don't ignore generated rst files

Mauro Carvalho Chehab <[email protected]> writes:

> Currently, the build system generates ReST files inside the
> source directory. This is not a good idea, specially when
> we have renames, as make clean won't get rid of them.

You're right that it's not a great idea, but it's the least bad option
with sphinx because it only supports 1 source dir. It doesn't have the
concept of a generated-sources dir and the alternative is to pollute the
output dir. See e.g. https://docs.kernel.org/media.h.rst

> As the first step to address the issue, stop ignoring those
> files. This way, we can see exactly what has been produced
> at build time inside $(srctree):
>
>         Documentation/networking/netlink_spec/conntrack.rst
>         Documentation/networking/netlink_spec/devlink.rst
>         Documentation/networking/netlink_spec/dpll.rst
>         Documentation/networking/netlink_spec/ethtool.rst
>         Documentation/networking/netlink_spec/fou.rst
>         Documentation/networking/netlink_spec/handshake.rst
>         Documentation/networking/netlink_spec/index.rst
>         Documentation/networking/netlink_spec/lockd.rst
>         Documentation/networking/netlink_spec/mptcp_pm.rst
>         Documentation/networking/netlink_spec/net_shaper.rst
>         Documentation/networking/netlink_spec/netdev.rst
>         Documentation/networking/netlink_spec/nfsd.rst
>         Documentation/networking/netlink_spec/nftables.rst
>         Documentation/networking/netlink_spec/nl80211.rst
>         Documentation/networking/netlink_spec/nlctrl.rst
>         Documentation/networking/netlink_spec/ovs_datapath.rst
>         Documentation/networking/netlink_spec/ovs_flow.rst
>         Documentation/networking/netlink_spec/ovs_vport.rst
>         Documentation/networking/netlink_spec/rt_addr.rst
>         Documentation/networking/netlink_spec/rt_link.rst
>         Documentation/networking/netlink_spec/rt_neigh.rst
>         Documentation/networking/netlink_spec/rt_route.rst
>         Documentation/networking/netlink_spec/rt_rule.rst
>         Documentation/networking/netlink_spec/tc.rst
>         Documentation/networking/netlink_spec/tcp_metrics.rst
>         Documentation/networking/netlink_spec/team.rst
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
>  Documentation/networking/netlink_spec/.gitignore | 1 -
>  1 file changed, 1 deletion(-)
>  delete mode 100644 Documentation/networking/netlink_spec/.gitignore
>
> diff --git a/Documentation/networking/netlink_spec/.gitignore b/Documentation/networking/netlink_spec/.gitignore
> deleted file mode 100644
> index 30d85567b592..000000000000
> --- a/Documentation/networking/netlink_spec/.gitignore
> +++ /dev/null
> @@ -1 +0,0 @@
> -*.rst