[Doc] Extension of Included configuration files

[Date Prev] [Date Next] [Thread Prev] [Thread Next] [Date Index] [Thread Index]

 



Hello,

I'm really happy that the 7.3 release of OpenSSH introduced the
Include directive.

However, since there is absolutely no restriction or advice neither on
the name nor on the location of the included files, it makes it harder
for external tools to recognize them; I'm mainly thinking about text
editors that would like to enable syntax coloration for it (
https://github.com/vim/vim/pull/1452 ).
Until now it wasn't a problem since the file was either `ssh_config`
or `~/.ssh/config` in most cases - maybe all ? no idea if this is
configurable.

I would like to include a SHOULD part to the man section of the
Include directive in an effort to make those included files
recognizable.
I'm sure you'll have a better suggestion for the wording than me;
however you'll find a patch attached for the sentence "Configuration
file(s) referenced by this Include directive should use the .sshconfig
extension to be detected as such by external tools." but it could also
be something simpler like "If you want external tools to detect your
configuration files, they should use the .sshconfig extension".

Let me know what you think about it,

Regards,

-- 
Alexis 'Horgix' Chotard
From 5505a289f3db1a37e6869de2032b330a0dff87fd Mon Sep 17 00:00:00 2001
From: Alexis Horgix Chotard <alexis.horgix.chotard@xxxxxxxxx>
Date: Tue, 7 Feb 2017 22:31:42 +0100
Subject: [PATCH] doc: add extension suggestion for Include

---
 ssh_config.5 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/ssh_config.5 b/ssh_config.5
index 016adbc7..75e5024a 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -977,6 +977,11 @@ or
 .Cm Host
 block
 to perform conditional inclusion.
+Configuration file(s) referenced by this
+.Cm Include
+directive should use the
+.Pa .sshconfig
+extension to be detected as such by external tools.
 .It Cm IPQoS
 Specifies the IPv4 type-of-service or DSCP class for connections.
 Accepted values are
-- 
2.11.0

_______________________________________________
openssh-unix-dev mailing list
openssh-unix-dev@xxxxxxxxxxx
https://lists.mindrot.org/mailman/listinfo/openssh-unix-dev

[Date Prev] [Date Next] [Thread Prev] [Thread Next] [Date Index] [Thread Index]

[Index of Archives]     [Linux ARM Kernel]     [Linux ARM]     [Linux Omap]     [Fedora ARM]     [IETF Annouce]     [Security]     [Bugtraq]     [Linux]     [Linux OMAP]     [Linux MIPS]     [ECOS]     [Asterisk Internet PBX]     [Linux API]

  Powered by Linux