Re: [Qemu-devel] [PATCH 2/7] block/vpc: Add link to available VHD documentation

[Stefan Weil]

Am 05.02.2013 11:23, schrieb Kevin Wolf:
> Am 01.02.2013 22:51, schrieb Stefan Weil:
>> Signed-off-by: Stefan Weil <address@hidden>
>> ---
>>  block/vpc.c |    3 +++
>>  1 file changed, 3 insertions(+)
>>
>> diff --git a/block/vpc.c b/block/vpc.c
>> index 1c55c21..4565723 100644
>> --- a/block/vpc.c
>> +++ b/block/vpc.c
>> @@ -21,6 +21,9 @@
>>   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
>> FROM,
>>   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
>>   * THE SOFTWARE.
>> + *
>> + * See http://en.wikipedia.org/wiki/VHD_(file_format) for more information
>> + * and links to the VHD specification.
>>   */
>>  #include "qemu-common.h"
>>  #include "block/block_int.h"
> Why not link directly to the real spec? The Wikipedia article doesn't
> contain any of the really interesting parts, i.e. how the format works
> internally. It's just a level of indirection.
>
> We could probably give a Wikipedia link for most of our source code
> files, but I doubt that it's really useful. When there is no URL
> provided, Wikipedia is the default starting point for most people anyway.
>
> Kevin

I simply did not want to link to MS because they change
URLs sometimes, so I prefer to have an indirection.

The indirection here is not quite obvious, because you
have to know that vpc.c implements VHD. The file should
be named block/vhd.c, and the protocol is also misnamed
in QEMU.

Stefan