[libcamera-devel] Added .cache directory to .gitignore under editors for clangd

11734 diff mbox series

Hello everyone! I am Abhay, I use NeoVim with coc.nvim using clangd which
generate .cache in the main folder, currently, there's no way to customize
that
according to the issue https://github.com/clangd/coc-clangd/issues/50

I am new to git over email, tbh this is my first patch. I followed a tut on
git-scm.com.
I drafted this using git send-email and am editing this in the Gmail draft.
I copied [libcamera-devel] from other emails, please do let me know
if did I something wrong and any better workflow.

Thanks!

Signed-off-by: Abhay Raj Singh <abhayofficialone@gmail.com>

---
 .gitignore | 3 +++
 1 file changed, 3 insertions(+)

--
2.31.0

Hey Abhay,

Thank you for the patch.

On 27.03.2021 10:33, Abhay Raj Singh wrote:
>Hello everyone! I am Abhay, I use NeoVim with coc.nvim using clangd which
>generate .cache in the main folder, currently, there's no way to customize
>that
>according to the issue https://github.com/clangd/coc-clangd/issues/50

That sounds like a very, very specific problem. Which probably won't be
encountered by many libcamera developers.

>
>I am new to git over email, tbh this is my first patch. I followed a tut on
>git-scm.com.
>I drafted this using git send-email and am editing this in the Gmail draft.
>I copied [libcamera-devel] from other emails, please do let me know
>if did I something wrong and any better workflow.

So, this patch basically helps you as you don't have to see the `.cache`
folder in the list of untracked files, but as I said above, I don't
believe that too many other developers will encounter that issue. Which
means, that we have to decide between adding 3 more lines to the
`.gitignore` file for an issue, that will be encountered very rarely, or
keeping the `.gitignore` file as minimal and clean as possible.

I would prefer to keep the `.gitignore` file tuned for the majority of
use-cases. If you don't want to see that folder you could modify your
local `.gitignore` file.

Please tell me if I missed something else, which would make this patch
beneficial.

>
>Thanks!

Greetings,
Sebastian

>
>Signed-off-by: Abhay Raj Singh <abhayofficialone@gmail.com>
>
>---
> .gitignore | 3 +++
> 1 file changed, 3 insertions(+)
>
>diff --git a/.gitignore b/.gitignore
>index d3d73615..08416dcb 100644
>--- a/.gitignore
>+++ b/.gitignore
>@@ -5,3 +5,6 @@ build/
> patches/
> *.patch
> *.pyc
>+
>+# editors
>+.cache/
>--
>2.31.0

>_______________________________________________
>libcamera-devel mailing list
>libcamera-devel@lists.libcamera.org
>https://lists.libcamera.org/listinfo/libcamera-devel

Yeah right I totally forgot about git update-index, sorry for the trouble
:facepalm:

Hey Abhay,

On Sat, Mar 27, 2021 at 11:25:44AM +0100, Sebastian Fricke wrote:
> On 27.03.2021 10:33, Abhay Raj Singh wrote:
> > Hello everyone! I am Abhay, I use NeoVim with coc.nvim using clangd which
> > generate .cache in the main folder, currently, there's no way to customize that
> > according to the issue https://github.com/clangd/coc-clangd/issues/50
> 
> That sounds like a very, very specific problem. Which probably won't be
> encountered by many libcamera developers.
> 
> > I am new to git over email, tbh this is my first patch. I followed a tut on
> > git-scm.com.
> > I drafted this using git send-email and am editing this in the Gmail draft.
> > I copied [libcamera-devel] from other emails, please do let me know
> > if did I something wrong and any better workflow.
> 
> So, this patch basically helps you as you don't have to see the `.cache`
> folder in the list of untracked files, but as I said above, I don't
> believe that too many other developers will encounter that issue. Which
> means, that we have to decide between adding 3 more lines to the
> `.gitignore` file for an issue, that will be encountered very rarely, or
> keeping the `.gitignore` file as minimal and clean as possible.
> 
> I would prefer to keep the `.gitignore` file tuned for the majority of
> use-cases. If you don't want to see that folder you could modify your
> local `.gitignore` file.
> 
> Please tell me if I missed something else, which would make this patch
> beneficial.

git looks for ignore patterns in multiple locations, as detailed by
`man gitignore`: $XDG_CONFIG_HOME/git/ignore, $GIT_DIR/info/exclude, and
.gitignore. For files created by your personal choices of tools, I
recommend to put ignore patterns in $XDG_CONFIG_HOME/git/ignore. They
will be taken into account for all your git repositories.

Note that if XDG_CONFIG_HOME isn't set, git assumes XDG_CONFIG_HOME to
be $HOME/.config.

Hello Abhay,

On Sat, Mar 27, 2021 at 10:33:34AM +0530, Abhay Raj Singh wrote:
> Hello everyone! I am Abhay, I use NeoVim with coc.nvim using clangd which
> generate .cache in the main folder, currently, there's no way to customize that
> according to the issue https://github.com/clangd/coc-clangd/issues/50

As others have mentioned, I think the proper solution is to use a global
gitignore for your user. I have one to ignore cscope and ctags files and
vim swap files, for example.

> I am new to git over email, tbh this is my first patch. I followed a tut on

I'll give feedback for your actual patch submission too, then.

> git-scm.com.
> I drafted this using git send-email

Good!

> and am editing this in the Gmail draft.

This, not so good. I'm not sure if you meant format-patch instead of
send-email, but after you generate the patch/email file with
git format-patch, you can edit that directly, and then you should send
that using git send-email. gmail is notorious for brutally murdering
patches (not to mention html patches won't be accepted).

> I copied [libcamera-devel] from other emails, please do let me know

I used to do that too, but you don't have to add [libcamera-devel], the
mailing list will add it automatically. It won't show up on the copy
that's CC-ed to you, which confused me too in the beginning :)

> if did I something wrong and any better workflow.

Last thing, these comments don't belong here. This is called the
changelog, and is where you explain your patch; the motivations, the
issues, the solution, etc. Comments like these that are questions or
personal comments that you don't want to be committed into the git
history forever belong after --- (where I marked <1>).

> 
> Thanks!

I look forward to your next contribution :)


Paul

> 
> Signed-off-by: Abhay Raj Singh <abhayofficialone@gmail.com>
> 
> ---

<1>

>  .gitignore | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/.gitignore b/.gitignore
> index d3d73615..08416dcb 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -5,3 +5,6 @@ build/
>  patches/
>  *.patch
>  *.pyc
> +
> +# editors
> +.cache/
> --
> 2.31.0

> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Hi Paul! Thanks for the feedback now I have more clarity of the patch
submission process.

I look forward to your next contribution :)
>

I will initiate it soon just wanted to make sure I don't mess up submission
^_^