Bug 47861 - DocSync.exe runs every time I open Xamarin Forms ANNOYING should be opt-in
Summary: DocSync.exe runs every time I open Xamarin Forms ANNOYING should be opt-in
Alias: None
Product: Visual Studio Extensions
Classification: Xamarin
Component: iOS ()
Version: 4.3.0 (C9)
Hardware: PC Windows
: High critical
Target Milestone: ---
Assignee: mag@xamarin.com
Depends on:
Reported: 2016-11-24 16:49 UTC by Karl Shifflett
Modified: 2016-12-01 03:59 UTC (History)
7 users (show)

Is this bug a regression?: ---
Last known good build:

DocSync tray icon UI (6.19 KB, image/png)
2016-12-01 03:59 UTC, Daniel Cazzulino

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.

Please create a new report on Developer Community with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:

Description Karl Shifflett 2016-11-24 16:49:45 UTC

In case you don't know, Visual Studio is ALWAYS opt-in for docs.  ALWAYS.

DocSync.exe runs every time I open Xamarin Forms  ANNOYING should be opt-in.

This should be a settings in Tools Options Xamarin to opp-in for DocSync.

Comment 1 Al Clark [MSFT] 2016-11-24 17:31:25 UTC
Updated to enhancement request in VS.
Comment 2 Daniel Cazzulino 2016-11-29 13:23:01 UTC
Maybe there is a slight misunderstanding on what DocSync does, what it downloads and for what.

Apple does not allow distribution of their web content as-is. Xamarin provides .NET APIs for Apple APIs. We translate to C# and adapt the API docs as much as possible, but quite often (especially when new APIs come out) we miss summary/remarks for some APIs.

We are talking about API Intellisense docs here, not product documentation. 

API documentation in Visual Studio is never opt-in. You can't opt-out of the (currently) 66MB of XML docs for .NET 4.x reference assemblies (see C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.X). 

In order for us to provide complete XML docs for Xamarin APIs, we must download the missing pieces and merge them with our own partial API docs, so that Visual Studio can load it. We must do this on your own machine, given the aforementioned Apple restriction. This is done only *once* per machine per the entire Xamarin installation. But you need to let it finish before it will stop trying to complete the job. 

Consider this a delayed part of your Xamarin installation, which is what it really is. We don't do it when you are installing the MSI, because the experience would be far worse, waiting for the entire thing to finish before being able to use the product.

That said, we should make clearer what we are downloading and why it's required, since it's not obvious from this bug report. We may also add the ability to pause the download or stop it altogether if you really really want to have incomplete intellisense docs for whatever reason.

Thanks for bringing up the issue.
Comment 3 Karl Shifflett 2016-11-29 13:26:59 UTC
Thank you for the response.

I must still have the same position.

Please make this opt-in or minimum opt-out.

Currently, I just delete the DocSync.exe or change it's execution permissions.

Please make this a much better experience.

For example, give a program to run, instead of just leaving VS open for an hour.


Comment 4 Miguel de Icaza [MSFT] 2016-11-29 14:22:05 UTC
Hello Karl,

Given that this should only download the code once, can you describe what is annoying about DocSync.exe running every time?
Comment 5 Karl Shifflett 2016-11-29 14:26:27 UTC
HI Miguel,

Yes, I launch VS and get the message.  Then I close and reopen and get the message.

I get this message everytime I open VS, so I set DocSync.exe permissions to not execute and I don't get the message.

How long does it take to update?

Wouldn't it be better to have an .exe that we run and it runs in the background, then I could close VS and reopen without disturbing this program.

Also the fact that I wrote a bug up for the behavior, makes the way it currently works undiscoverable.

Thanks for the reply.


Comment 6 Jose Gallardo 2016-11-29 15:38:54 UTC
Hi Karl,

Agreed on the annoyance of having the message toast visible on every VS run until it completes. That's something we need to fix.
For instance, it doesn't add any value to have that toast forcibly visible to the user at that point. We'll keep the icon on the Windows Tray, so the user can interact with it if needed, but we'll remove the toast showing up on the screen with the message.

Thanks for reporting the issue
Comment 7 Karl Shifflett 2016-11-29 15:54:09 UTC
Hi Jose,

One problem, the icon in the icon tray does not allow me to do anything.  Clicking on it does nothing.  

Another reason I keep it from running.

Question:  Are you able to do anything with the icon?


Comment 8 xamarin-release-manager 2016-11-29 18:37:09 UTC
Fixed in version (cycle9)

Author: Mauro Agnoletti
Commit: b64954844c59f8863df547cddabedef5462ba4bd (xamarin/XamarinVS)
Comment 9 Daniel Cazzulino 2016-12-01 03:59:23 UTC
Created attachment 18731 [details]
DocSync tray icon UI

Clicking on the icon shows you what's being done, attached screenshot.