git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Jakub Narębski" <jnareb@gmail.com>
To: CLOSE Dave <Dave.Close@us.thalesgroup.com>,
	"git@vger.kernel.org" <git@vger.kernel.org>
Subject: Re: Complex gitweb URL
Date: Sat, 23 Jul 2016 19:47:24 +0200	[thread overview]
Message-ID: <5793ADAC.6030009@gmail.com> (raw)
In-Reply-To: <225e6ff4-178c-cd2a-6a05-b621f0ad4a84@us.thalesgroup.com>

W dniu 2016-07-20 o 21:24, CLOSE Dave pisze:

> I'm trying to create a URL that will always refer to the latest version 
> of a file stored under Gerrit. gitweb access is available. The man page 
> specification doesn't seem to work for me. Instead, I seem to need to 
> put most of the information into arguments (after the '?').
[...]
> 
> Are these arguments documented somewhere? What is the recommended way to 
> construct a URL like I need?

Actually it turns out that gitweb URLs are described in gitweb(1) manpage
https://git.github.io/htmldocs/gitweb.html#_actions_and_urls in the
"Actions, and URLs" section.

What was missing was explanation of available query parameters (the URL
arguments after the '?').  Would the following patch help, or is it still
missing something (NOTE: not tested)?:

----- >8 ------------------------------------------------------ >8 -----
Subject: [PATCH] gitweb(1): Document query parameters

The gitweb manpage includes description of gitweb URL structure,
but it was limited to passing parameters in the path part of URL
('path info'), and it didn't include explanation of query parameters.
---
 Documentation/gitweb.txt | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 96156e5..301003f 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -395,6 +395,43 @@ atom::
 	Generates an RSS (or Atom) feed of changes to repository.
 
 
+Query parameters:
+~~~~~~~~~~~~~~~~~
+In some cases gitweb cannot pass a parameter in path part of URL, for
+example if a filename contains double dots ('..') inside.  All parameters
+that cannot be passed in that way are put as a query parameter, that is
+after '?'.
+
+By default gitweb would generate links using query parameters, unless
+the original URL was using path part, or gitweb was configured to use
+pathinfo with the 'pathinfo' feature. All gitweb installations recognize
+URL in either format, so you can use one that is better for you when
+interacting with gitweb (handcrafting or editing URLs, or creating
+a program interacting with gitweb installation).
+
+Here is the list of some of query parameters, together with their
+long names (which should help remembering the short name of
+each parameter):
+
+'a' (action)::
+	The action that will be run.
+
+'p' (project)::
+	The project repository that will be displayed.
+
+'h' (hash)::
+	The object id of displayed object (commit, tag, tree, blob).
+	In case of files 'hb' (hash_base) and 'f' (filename) might be
+	used instead.
+
+'hp' (hash_parent)::
+'fp' (file_parent)::
+'hpb' (hash_parent_base)::
+      Those parameters define the second object for diff-like actions,
+      the object gitweb is comparing againts.
+
+
+
 WEBSERVER CONFIGURATION
 -----------------------
 This section explains how to configure some common webservers to run gitweb. In
-- 
2.6.3




  parent reply	other threads:[~2016-07-23 17:47 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-07-20 19:24 Complex gitweb URL CLOSE Dave
2016-07-20 21:20 ` Jakub Narębski
2016-07-20 21:35   ` CLOSE Dave
2016-07-20 21:50     ` Jakub Narębski
2016-07-20 21:46   ` CLOSE Dave
2016-07-23 17:47 ` Jakub Narębski [this message]
2016-07-25 16:34   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5793ADAC.6030009@gmail.com \
    --to=jnareb@gmail.com \
    --cc=Dave.Close@us.thalesgroup.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).