Support XDG base directory specification #2384

itchyny · 2019-12-19T05:43:14Z

This is a poc implementation for checking $XDG_CONFIG_HOME and loads the $XDG_CONFIG_HOME/ctags/*.ctags (fixes #89). But yes, I know the current implementation is not compliant to the specification (when $XDG_CONFIG_HOME is empty or unset, it should fallback to ~/.config/ctags). Note that we still have to use the .ctags extension (can't use $XDG_CONFIG_HOME/ctags/config) but is reasonable to split the config per languages.

EDIT: Now the implementation is compliant to the XDG base directory specification (I believe).

coveralls · 2019-12-19T05:46:08Z

Coverage increased (+0.002%) to 86.375% when pulling 78b7a9b on itchyny:support-xdg-config-home into e216bb4 on universal-ctags:master.

itchyny · 2019-12-19T05:46:16Z

main/options.c


-	return full_path;
+	return combinePathAndFile(envval, path);


I believe we should not fallback to /ctags when the environment variable is not set.

Good catch!

I would like to introduce a fix for this important suggestion first.
I made a pull request for the fix. See #2385.

codecov-io · 2019-12-19T05:51:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.25%. Comparing base (e216bb4) to head (78b7a9b).
Report is 3675 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2384   +/-   ##
=======================================
  Coverage   86.25%   86.25%           
=======================================
  Files         176      176           
  Lines       35740    35738    -2     
=======================================
- Hits        30828    30827    -1     
+ Misses       4912     4911    -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…ecification

@itchyny

… name combinePathAndFile takes two C strings. The first one PATH was used in an expression: path [strlen(path) - 1] . If PATH is an empty, this can cause a buffer overrun. This change adds a guard-condition for such processing. Inspired from the comment submitted by @itchyny in universal-ctags#2384.

@itchyny

Suggested by @itchyny in universal-ctags#2384. When $HOME is set but it is an empty string,

@itchyny

…PATH are empty Inspired from the comment submitted by @itchyny in universal-ctags#2384.

@itchyny

Suggested by @itchyny in universal-ctags#2384. When $HOME is set but it is an empty string,

@itchyny

…d file name combinePathAndFile takes two C strings. The first one PATH was used in an expression: path [strlen(path) - 1] . If PATH is an empty, this can cause a buffer overrun. This change adds a guard-condition for such processing. Inspired from the comment submitted by @itchyny in universal-ctags#2384.

@itchyny

…PATH are empty Inspired from the comment submitted by @itchyny in universal-ctags#2384.

masatake · 2019-12-23T14:19:49Z

not compliant to the specification

So how we should do?

A. this change is not compliant to the specification, therefore this pull request is just for discussion, not for merging.
B. this change is not compliant to the specification, however, we should merge this because this change is useful.

For A, I have no strong comment. Simply say, I don't want to take much time for this topic.
For B, we need much more documents for the usefulness. The documents explain introducing this change is much more valuable than the incompliant. I think in the future we will get a bug report "ctags configuration loader isn't compliant to XDG standard". I think I cannot respond to the bug report.
The document may help me.

I want a test case. I can give you hints for writing. Any way I would like to hear the basic direction, A or B.

…DG base directory specification compliant

itchyny · 2019-12-24T03:52:24Z

I added ~/.config/ctags fallback to follow the specification (I was just unconfident that I can write slash in .path).

masatake · 2019-12-24T11:18:50Z

Tmain/load-conf-files-under-default-xdg-config-home/run.sh

@@ -0,0 +1,12 @@
+# Copyright: 2017 Masatake YAMATO


I didn't write this script.

masatake · 2019-12-24T11:29:15Z

Thank you for adding the test case.

Note that we still have to use the .ctags extension (can't use $XDG_CONFIG_HOME/ctags/config) but is reasonable to split the config per languages.

Does this violate the specification? or Is it acceptable in the specification?

I would like you to add minimum code for satisfying the specification.
.ctags loader is already complicated.

itchyny · 2019-12-24T12:00:30Z

Does this violate the specification?

No. It's just a note for users (including me) who is not used to the behavior of universal-ctags. I believe the current implementation is compliant to the spec.
I'd like to hear some opinions from those who might be interested in XDG config support. @majutsushi @fishman @blueyed @justinmk @cweagans @dsifford (who commented in #89).

masatake · 2019-12-24T12:43:49Z

Tmain/load-conf-files-under-default-xdg-config-home/run.sh

@@ -1,12 +1,10 @@
-# Copyright: 2017 Masatake YAMATO


Copyright notice is neeed, but is not mine.

masatake · 2019-12-24T12:44:05Z

Tmain/load-conf-files-under-xdg-config-home/run.sh

@@ -1,11 +1,9 @@
-# Copyright: 2017 Masatake YAMATO


Copyright notice is neeed, but is not mine.

masatake · 2019-12-24T15:30:58Z

Thank you for updating.

majutsushi · 2019-12-25T04:38:43Z

Looks reasonable to me.

masatake · 2019-12-25T16:06:16Z

@majutsushi, thank you for veryfing.

This pull request is mostly ready for merging.
However, I would like to keep the history of our repository simple; I don't want to introduce try-and-error commits like 569c087 and 78b7a9b.

So I rearranged the commits in this pull request and made a new pull request. @itchyny, could you look into #2386?

masatake · 2019-12-28T15:32:44Z

Merged via #2386. Thank you.

itchyny commented Dec 19, 2019

View reviewed changes

itchyny force-pushed the support-xdg-config-home branch from e0e0303 to 01951ed Compare December 19, 2019 07:02

itchyny added 2 commits December 19, 2019 18:52

Load $XDG_CONFIG_HOME/ctags/*.ctags and respect XDG base directory sp…

433c32c

…ecification

Skip searching directory when environment variable is unset or empty

90ec955

itchyny force-pushed the support-xdg-config-home branch from 01951ed to 90ec955 Compare December 19, 2019 09:52

Update documents about XDG base directory support

7f9e5d2

masatake self-assigned this Dec 19, 2019

masatake self-requested a review December 20, 2019 03:01

masatake added a commit to masatake/ctags that referenced this pull request Dec 23, 2019

main: handle the case when $HOME is empty

fc533cd

Suggested by @itchyny in universal-ctags#2384. When $HOME is set but it is an empty string,

masatake added a commit to masatake/ctags that referenced this pull request Dec 23, 2019

main,win32: don't load configuration files if both HOMEDRIVE and HOME…

610d1fe

…PATH are empty Inspired from the comment submitted by @itchyny in universal-ctags#2384.

masatake mentioned this pull request Dec 23, 2019

main: Handle empty HOME, HOMEDRIVE, and HOMEPATH envvar #2385

Closed

masatake added a commit to masatake/ctags that referenced this pull request Dec 23, 2019

main: handle the case when $HOME is empty

bb37758

Suggested by @itchyny in universal-ctags#2384. When $HOME is set but it is an empty string,

masatake added a commit to masatake/ctags that referenced this pull request Dec 23, 2019

main,win32: don't load configuration files if both HOMEDRIVE and HOME…

41bb8fb

…PATH are empty Inspired from the comment submitted by @itchyny in universal-ctags#2384.

Add ~/.config/ctags to config directory candidates in order to make X…

917c6b3

…DG base directory specification compliant

itchyny force-pushed the support-xdg-config-home branch from 4e764b3 to 0fc197b Compare December 24, 2019 03:43

Add tests for XDG base directory specification support

7f0c832

itchyny force-pushed the support-xdg-config-home branch from 0fc197b to 7f0c832 Compare December 24, 2019 03:47

masatake reviewed Dec 24, 2019

View reviewed changes

itchyny added 2 commits December 24, 2019 20:55

There's no need to write copyrights to the test scripts

569c087

Comment the intended behavior in the test scripts

53af399

masatake reviewed Dec 24, 2019

View reviewed changes

Restore copyright to the test scripts

78b7a9b

masatake mentioned this pull request Dec 26, 2019

<FOCUSING ON non-Windows> main: support XDG base directory specification (based on #2384, rearranged) #2386

Merged

masatake closed this Dec 28, 2019

itchyny deleted the support-xdg-config-home branch December 28, 2019 16:26

davidosomething added a commit to davidosomething/dotfiles that referenced this pull request Mar 26, 2020

universal-ctags is XDG compliant now universal-ctags/ctags#2384

115181a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support XDG base directory specification #2384

Support XDG base directory specification #2384

itchyny commented Dec 19, 2019 •

edited

Loading

coveralls commented Dec 19, 2019 •

edited

Loading

itchyny Dec 19, 2019

masatake Dec 23, 2019

codecov-io commented Dec 19, 2019 •

edited by codecov bot

Loading

masatake commented Dec 23, 2019

itchyny commented Dec 24, 2019

masatake Dec 24, 2019 •

edited

Loading

masatake commented Dec 24, 2019 •

edited

Loading

itchyny commented Dec 24, 2019

masatake Dec 24, 2019

masatake Dec 24, 2019

masatake commented Dec 24, 2019

majutsushi commented Dec 25, 2019

masatake commented Dec 25, 2019

masatake commented Dec 28, 2019

Support XDG base directory specification #2384

Support XDG base directory specification #2384

Conversation

itchyny commented Dec 19, 2019 • edited Loading

coveralls commented Dec 19, 2019 • edited Loading

itchyny Dec 19, 2019

Choose a reason for hiding this comment

masatake Dec 23, 2019

Choose a reason for hiding this comment

codecov-io commented Dec 19, 2019 • edited by codecov bot Loading

Codecov Report

masatake commented Dec 23, 2019

itchyny commented Dec 24, 2019

masatake Dec 24, 2019 • edited Loading

Choose a reason for hiding this comment

masatake commented Dec 24, 2019 • edited Loading

itchyny commented Dec 24, 2019

masatake Dec 24, 2019

Choose a reason for hiding this comment

masatake Dec 24, 2019

Choose a reason for hiding this comment

masatake commented Dec 24, 2019

majutsushi commented Dec 25, 2019

masatake commented Dec 25, 2019

masatake commented Dec 28, 2019

itchyny commented Dec 19, 2019 •

edited

Loading

coveralls commented Dec 19, 2019 •

edited

Loading

codecov-io commented Dec 19, 2019 •

edited by codecov bot

Loading

masatake Dec 24, 2019 •

edited

Loading

masatake commented Dec 24, 2019 •

edited

Loading