Pacman

Historical bug tracker for the Pacman package manager.

The pacman bug tracker has moved to gitlab:
https://gitlab.archlinux.org/pacman/pacman/-/issues

This tracker remains open for interaction with historical bugs during the transition period. Any new bugs reports will be closed without further action.
Tasklist

FS#20259 - pacman.conf man page clairity

Attached to Project: Pacman
Opened by Mr. K. (KitchM) - Thursday, 22 July 2010, 15:55 GMT
Last edited by Xavier (shining) - Monday, 15 November 2010, 09:59 GMT
Task Type Support Request
Category Documentation
Status Closed
Assigned To No-one
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 1
Private No

Details

Description:
The man page at http://www.archlinux.org/pacman/pacman.conf.5.html states:
"During parsing, pacman will define the $repo variable to the name of the current section. This is often utilized in files specified using the Include directive so all repositories can use the same mirrorfile. pacman also defines the $arch variable to the value of Architecture, so the same mirrorfile can even be used for different architectures."


Additional info:
* package version(s)
* config and/or log files etc.


Steps to reproduce:
Read man page
This task depends upon

Closed by  Xavier (shining)
Monday, 15 November 2010, 09:59 GMT
Reason for closing:  Not a bug
Additional comments about closing:  this bug lacks clairity.
ooooh or did you mean clarity ?
Comment by Allan McRae (Allan) - Thursday, 22 July 2010, 22:05 GMT
What is not clear about that?
Comment by Mr. K. (KitchM) - Friday, 23 July 2010, 16:56 GMT
During parsing of what? What is parsing? What does it mean by "define"? "Current section" of what? Where are the names? Etc. Etc. ........
Comment by Allan McRae (Allan) - Friday, 23 July 2010, 23:29 GMT
Parsing of what, current section of what? I thought the command used to read that file would give you a hint "man pacman.conf"...

And you seriously want "define" defined?
Comment by Mr. K. (KitchM) - Monday, 26 July 2010, 20:00 GMT
Discerning people understand that context is everything. Also, you seemed to be implying that you wanted examples. I gave you only some of them.
Comment by Matthew (piezoelectric) - Thursday, 05 August 2010, 00:00 GMT
I find that most man pages are written for long term reference and it's not unreasonable for the authors to expect readers to need to reread them multiple times to pick up on certain subtleties. I think in this case, give that you are reading the manpage for pacman.conf, it is quite obvious that pacman is parsing pacman.conf. And given the *context* of the heading (Repository Sections), it's also quite obvious what sections we're talking about.
Comment by Mr. K. (KitchM) - Saturday, 07 August 2010, 05:37 GMT
It is actually the opposite that determines the quality of writing; if a reader gets it during the first read, it is easily understood, and therefore properly written. This is even more important in situations where the purpose of the text is to act as a help file and to explain things for the benefit of the reader/user.

I actually did not get that explanation of parsing as you did. Interesting.

The context issue is an interesting one because it actually appears to be associated with the $repo variable.
It was good to learn, however indirectly, that the variable $repo is used repeatedly for each section name, in turn (if I get the gist of what you wrote). However, I now believe that to be wrong. I guess I now understand that what should have been written was "As the pacman program processes the information it finds in pacman.conf, it replaces the variable $repo with the address of the repository from each section it finds, in turn, from top to bottom, as it searches the repos thru the Internet for the file needed". But that appears to be only if it is in the Include directive. But then that brings up the question "Why have separate sections and not just put everything under the directive?".

Now please keep in mind that I understand that you may not want to target those who do not understand your inside language usage, and that's fine. But what does not make sense is when others wish to help clarify and make the file more useful to more people, that you people would use a tone that is very discouraging and unwelcoming. It's free help, for pity's sake! Where's the downside?

(Unless, that is, you really believe you've written a great man page.)

Loading...